Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-apimanagement

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AlwaysLog

AlwaysLog: "allErrors"

Defines values for AlwaysLog. Possible values include: 'allErrors'

readonly
enum

{string}

ApiCreateOrUpdateResponse

ApiCreateOrUpdateResponse: ApiContract & ApiCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiDiagnosticCreateOrUpdateResponse

ApiDiagnosticCreateOrUpdateResponse: DiagnosticContract & ApiDiagnosticCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiDiagnosticGetEntityTagResponse

ApiDiagnosticGetEntityTagResponse: ApiDiagnosticGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiDiagnosticGetResponse

ApiDiagnosticGetResponse: DiagnosticContract & ApiDiagnosticGetHeaders & object

Contains response data for the get operation.

ApiDiagnosticListByServiceNextResponse

ApiDiagnosticListByServiceNextResponse: DiagnosticCollection & object

Contains response data for the listByServiceNext operation.

ApiDiagnosticListByServiceResponse

ApiDiagnosticListByServiceResponse: DiagnosticCollection & object

Contains response data for the listByService operation.

ApiExportGetResponse

ApiExportGetResponse: ApiExportResult & object

Contains response data for the get operation.

ApiGetEntityTagResponse

ApiGetEntityTagResponse: ApiGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiGetResponse

ApiGetResponse: ApiContract & ApiGetHeaders & object

Contains response data for the get operation.

ApiIssueAttachmentCreateOrUpdateResponse

ApiIssueAttachmentCreateOrUpdateResponse: IssueAttachmentContract & ApiIssueAttachmentCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiIssueAttachmentGetEntityTagResponse

ApiIssueAttachmentGetEntityTagResponse: ApiIssueAttachmentGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiIssueAttachmentGetResponse

ApiIssueAttachmentGetResponse: IssueAttachmentContract & ApiIssueAttachmentGetHeaders & object

Contains response data for the get operation.

ApiIssueAttachmentListByServiceNextResponse

ApiIssueAttachmentListByServiceNextResponse: IssueAttachmentCollection & object

Contains response data for the listByServiceNext operation.

ApiIssueAttachmentListByServiceResponse

ApiIssueAttachmentListByServiceResponse: IssueAttachmentCollection & object

Contains response data for the listByService operation.

ApiIssueCommentCreateOrUpdateResponse

ApiIssueCommentCreateOrUpdateResponse: IssueCommentContract & ApiIssueCommentCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiIssueCommentGetEntityTagResponse

ApiIssueCommentGetEntityTagResponse: ApiIssueCommentGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiIssueCommentGetResponse

ApiIssueCommentGetResponse: IssueCommentContract & ApiIssueCommentGetHeaders & object

Contains response data for the get operation.

ApiIssueCommentListByServiceNextResponse

ApiIssueCommentListByServiceNextResponse: IssueCommentCollection & object

Contains response data for the listByServiceNext operation.

ApiIssueCommentListByServiceResponse

ApiIssueCommentListByServiceResponse: IssueCommentCollection & object

Contains response data for the listByService operation.

ApiIssueCreateOrUpdateResponse

ApiIssueCreateOrUpdateResponse: IssueContract & ApiIssueCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiIssueGetEntityTagResponse

ApiIssueGetEntityTagResponse: ApiIssueGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiIssueGetResponse

ApiIssueGetResponse: IssueContract & ApiIssueGetHeaders & object

Contains response data for the get operation.

ApiIssueListByServiceNextResponse

ApiIssueListByServiceNextResponse: IssueCollection & object

Contains response data for the listByServiceNext operation.

ApiIssueListByServiceResponse

ApiIssueListByServiceResponse: IssueCollection & object

Contains response data for the listByService operation.

ApiListByServiceNextResponse

ApiListByServiceNextResponse: ApiCollection & object

Contains response data for the listByServiceNext operation.

ApiListByServiceResponse

ApiListByServiceResponse: ApiCollection & object

Contains response data for the listByService operation.

ApiListByTagsNextResponse

ApiListByTagsNextResponse: TagResourceCollection & object

Contains response data for the listByTagsNext operation.

ApiListByTagsResponse

ApiListByTagsResponse: TagResourceCollection & object

Contains response data for the listByTags operation.

ApiManagementOperationsListNextResponse

ApiManagementOperationsListNextResponse: OperationListResult & object

Contains response data for the listNext operation.

ApiManagementOperationsListResponse

ApiManagementOperationsListResponse: OperationListResult & object

Contains response data for the list operation.

ApiManagementServiceApplyNetworkConfigurationUpdatesResponse

ApiManagementServiceApplyNetworkConfigurationUpdatesResponse: ApiManagementServiceResource & object

Contains response data for the applyNetworkConfigurationUpdates operation.

ApiManagementServiceBackupResponse

ApiManagementServiceBackupResponse: ApiManagementServiceResource & object

Contains response data for the backup operation.

ApiManagementServiceBeginApplyNetworkConfigurationUpdatesResponse

ApiManagementServiceBeginApplyNetworkConfigurationUpdatesResponse: ApiManagementServiceResource & object

Contains response data for the beginApplyNetworkConfigurationUpdates operation.

ApiManagementServiceBeginBackupResponse

ApiManagementServiceBeginBackupResponse: ApiManagementServiceResource & object

Contains response data for the beginBackup operation.

ApiManagementServiceBeginCreateOrUpdateResponse

ApiManagementServiceBeginCreateOrUpdateResponse: ApiManagementServiceResource & object

Contains response data for the beginCreateOrUpdate operation.

ApiManagementServiceBeginDeleteMethodResponse

ApiManagementServiceBeginDeleteMethodResponse: ApiManagementServiceResource & object

Contains response data for the beginDeleteMethod operation.

ApiManagementServiceBeginRestoreResponse

ApiManagementServiceBeginRestoreResponse: ApiManagementServiceResource & object

Contains response data for the beginRestore operation.

ApiManagementServiceBeginUpdateResponse

ApiManagementServiceBeginUpdateResponse: ApiManagementServiceResource & object

Contains response data for the beginUpdate operation.

ApiManagementServiceCheckNameAvailabilityResponse

ApiManagementServiceCheckNameAvailabilityResponse: ApiManagementServiceNameAvailabilityResult & object

Contains response data for the checkNameAvailability operation.

ApiManagementServiceCreateOrUpdateResponse

ApiManagementServiceCreateOrUpdateResponse: ApiManagementServiceResource & object

Contains response data for the createOrUpdate operation.

ApiManagementServiceDeleteMethodResponse

ApiManagementServiceDeleteMethodResponse: ApiManagementServiceResource & object

Contains response data for the deleteMethod operation.

ApiManagementServiceGetResponse

ApiManagementServiceGetResponse: ApiManagementServiceResource & object

Contains response data for the get operation.

ApiManagementServiceGetSsoTokenResponse

ApiManagementServiceGetSsoTokenResponse: ApiManagementServiceGetSsoTokenResult & object

Contains response data for the getSsoToken operation.

ApiManagementServiceListByResourceGroupNextResponse

ApiManagementServiceListByResourceGroupNextResponse: ApiManagementServiceListResult & object

Contains response data for the listByResourceGroupNext operation.

ApiManagementServiceListByResourceGroupResponse

ApiManagementServiceListByResourceGroupResponse: ApiManagementServiceListResult & object

Contains response data for the listByResourceGroup operation.

ApiManagementServiceListNextResponse

ApiManagementServiceListNextResponse: ApiManagementServiceListResult & object

Contains response data for the listNext operation.

ApiManagementServiceListResponse

ApiManagementServiceListResponse: ApiManagementServiceListResult & object

Contains response data for the list operation.

ApiManagementServiceRestoreResponse

ApiManagementServiceRestoreResponse: ApiManagementServiceResource & object

Contains response data for the restore operation.

ApiManagementServiceSkusListAvailableServiceSkusNextResponse

ApiManagementServiceSkusListAvailableServiceSkusNextResponse: ResourceSkuResults & object

Contains response data for the listAvailableServiceSkusNext operation.

ApiManagementServiceSkusListAvailableServiceSkusResponse

ApiManagementServiceSkusListAvailableServiceSkusResponse: ResourceSkuResults & object

Contains response data for the listAvailableServiceSkus operation.

ApiManagementServiceUpdateResponse

ApiManagementServiceUpdateResponse: ApiManagementServiceResource & object

Contains response data for the update operation.

ApiOperationCreateOrUpdateResponse

ApiOperationCreateOrUpdateResponse: OperationContract & ApiOperationCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiOperationGetEntityTagResponse

ApiOperationGetEntityTagResponse: ApiOperationGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiOperationGetResponse

ApiOperationGetResponse: OperationContract & ApiOperationGetHeaders & object

Contains response data for the get operation.

ApiOperationListByApiNextResponse

ApiOperationListByApiNextResponse: OperationCollection & object

Contains response data for the listByApiNext operation.

ApiOperationListByApiResponse

ApiOperationListByApiResponse: OperationCollection & object

Contains response data for the listByApi operation.

ApiOperationPolicyCreateOrUpdateResponse

ApiOperationPolicyCreateOrUpdateResponse: PolicyContract & ApiOperationPolicyCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiOperationPolicyGetEntityTagResponse

ApiOperationPolicyGetEntityTagResponse: ApiOperationPolicyGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiOperationPolicyGetResponse

ApiOperationPolicyGetResponse: PolicyContract & ApiOperationPolicyGetHeaders & object

Contains response data for the get operation.

ApiOperationPolicyListByOperationResponse

ApiOperationPolicyListByOperationResponse: PolicyCollection & object

Contains response data for the listByOperation operation.

ApiPolicyCreateOrUpdateResponse

ApiPolicyCreateOrUpdateResponse: PolicyContract & ApiPolicyCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiPolicyGetEntityTagResponse

ApiPolicyGetEntityTagResponse: ApiPolicyGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiPolicyGetResponse

ApiPolicyGetResponse: PolicyContract & ApiPolicyGetHeaders & object

Contains response data for the get operation.

ApiPolicyListByApiResponse

ApiPolicyListByApiResponse: PolicyCollection & object

Contains response data for the listByApi operation.

ApiProductListByApisNextResponse

ApiProductListByApisNextResponse: ProductCollection & object

Contains response data for the listByApisNext operation.

ApiProductListByApisResponse

ApiProductListByApisResponse: ProductCollection & object

Contains response data for the listByApis operation.

ApiReleaseCreateOrUpdateResponse

ApiReleaseCreateOrUpdateResponse: ApiReleaseContract & ApiReleaseCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiReleaseGetEntityTagResponse

ApiReleaseGetEntityTagResponse: ApiReleaseGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiReleaseGetResponse

ApiReleaseGetResponse: ApiReleaseContract & ApiReleaseGetHeaders & object

Contains response data for the get operation.

ApiReleaseListByServiceNextResponse

ApiReleaseListByServiceNextResponse: ApiReleaseCollection & object

Contains response data for the listByServiceNext operation.

ApiReleaseListByServiceResponse

ApiReleaseListByServiceResponse: ApiReleaseCollection & object

Contains response data for the listByService operation.

ApiRevisionListByServiceNextResponse

ApiRevisionListByServiceNextResponse: ApiRevisionCollection & object

Contains response data for the listByServiceNext operation.

ApiRevisionListByServiceResponse

ApiRevisionListByServiceResponse: ApiRevisionCollection & object

Contains response data for the listByService operation.

ApiSchemaCreateOrUpdateResponse

ApiSchemaCreateOrUpdateResponse: SchemaContract & ApiSchemaCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiSchemaGetEntityTagResponse

ApiSchemaGetEntityTagResponse: ApiSchemaGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiSchemaGetResponse

ApiSchemaGetResponse: SchemaContract & ApiSchemaGetHeaders & object

Contains response data for the get operation.

ApiSchemaListByApiNextResponse

ApiSchemaListByApiNextResponse: SchemaCollection & object

Contains response data for the listByApiNext operation.

ApiSchemaListByApiResponse

ApiSchemaListByApiResponse: SchemaCollection & object

Contains response data for the listByApi operation.

ApiTagDescriptionCreateOrUpdateResponse

ApiTagDescriptionCreateOrUpdateResponse: TagDescriptionContract & ApiTagDescriptionCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiTagDescriptionGetEntityTagResponse

ApiTagDescriptionGetEntityTagResponse: ApiTagDescriptionGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiTagDescriptionGetResponse

ApiTagDescriptionGetResponse: TagDescriptionContract & ApiTagDescriptionGetHeaders & object

Contains response data for the get operation.

ApiTagDescriptionListByServiceNextResponse

ApiTagDescriptionListByServiceNextResponse: TagDescriptionCollection & object

Contains response data for the listByServiceNext operation.

ApiTagDescriptionListByServiceResponse

ApiTagDescriptionListByServiceResponse: TagDescriptionCollection & object

Contains response data for the listByService operation.

ApiType

ApiType: "http" | "soap"

Defines values for ApiType. Possible values include: 'http', 'soap'

readonly
enum

{string}

ApiVersionSetCreateOrUpdateResponse

ApiVersionSetCreateOrUpdateResponse: ApiVersionSetContract & ApiVersionSetCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ApiVersionSetGetEntityTagResponse

ApiVersionSetGetEntityTagResponse: ApiVersionSetGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ApiVersionSetGetResponse

ApiVersionSetGetResponse: ApiVersionSetContract & ApiVersionSetGetHeaders & object

Contains response data for the get operation.

ApiVersionSetListByServiceNextResponse

ApiVersionSetListByServiceNextResponse: ApiVersionSetCollection & object

Contains response data for the listByServiceNext operation.

ApiVersionSetListByServiceResponse

ApiVersionSetListByServiceResponse: ApiVersionSetCollection & object

Contains response data for the listByService operation.

AsyncOperationStatus

AsyncOperationStatus: "Started" | "InProgress" | "Succeeded" | "Failed"

Defines values for AsyncOperationStatus. Possible values include: 'Started', 'InProgress', 'Succeeded', 'Failed'

readonly
enum

{string}

AuthorizationMethod

AuthorizationMethod: "HEAD" | "OPTIONS" | "TRACE" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE"

Defines values for AuthorizationMethod. Possible values include: 'HEAD', 'OPTIONS', 'TRACE', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'

readonly
enum

{string}

AuthorizationServerCreateOrUpdateResponse

AuthorizationServerCreateOrUpdateResponse: AuthorizationServerContract & AuthorizationServerCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

AuthorizationServerGetEntityTagResponse

AuthorizationServerGetEntityTagResponse: AuthorizationServerGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

AuthorizationServerGetResponse

AuthorizationServerGetResponse: AuthorizationServerContract & AuthorizationServerGetHeaders & object

Contains response data for the get operation.

AuthorizationServerListByServiceNextResponse

AuthorizationServerListByServiceNextResponse: AuthorizationServerCollection & object

Contains response data for the listByServiceNext operation.

AuthorizationServerListByServiceResponse

AuthorizationServerListByServiceResponse: AuthorizationServerCollection & object

Contains response data for the listByService operation.

BackendCreateOrUpdateResponse

BackendCreateOrUpdateResponse: BackendContract & BackendCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

BackendGetEntityTagResponse

BackendGetEntityTagResponse: BackendGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

BackendGetResponse

BackendGetResponse: BackendContract & BackendGetHeaders & object

Contains response data for the get operation.

BackendListByServiceNextResponse

BackendListByServiceNextResponse: BackendCollection & object

Contains response data for the listByServiceNext operation.

BackendListByServiceResponse

BackendListByServiceResponse: BackendCollection & object

Contains response data for the listByService operation.

BackendProtocol

BackendProtocol: "http" | "soap"

Defines values for BackendProtocol. Possible values include: 'http', 'soap'

readonly
enum

{string}

BearerTokenSendingMethod

BearerTokenSendingMethod: "authorizationHeader" | "query"

Defines values for BearerTokenSendingMethod. Possible values include: 'authorizationHeader', 'query'

readonly
enum

{string}

BearerTokenSendingMethods

BearerTokenSendingMethods: "authorizationHeader" | "query"

Defines values for BearerTokenSendingMethods. Possible values include: 'authorizationHeader', 'query'

readonly
enum

{string}

CacheCreateOrUpdateResponse

CacheCreateOrUpdateResponse: CacheContract & CacheCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

CacheGetEntityTagResponse

CacheGetEntityTagResponse: CacheGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

CacheGetResponse

CacheGetResponse: CacheContract & CacheGetHeaders & object

Contains response data for the get operation.

CacheListByServiceNextResponse

CacheListByServiceNextResponse: CacheCollection & object

Contains response data for the listByServiceNext operation.

CacheListByServiceResponse

CacheListByServiceResponse: CacheCollection & object

Contains response data for the listByService operation.

CertificateCreateOrUpdateResponse

CertificateCreateOrUpdateResponse: CertificateContract & CertificateCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

CertificateGetEntityTagResponse

CertificateGetEntityTagResponse: CertificateGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

CertificateGetResponse

CertificateGetResponse: CertificateContract & CertificateGetHeaders & object

Contains response data for the get operation.

CertificateListByServiceNextResponse

CertificateListByServiceNextResponse: CertificateCollection & object

Contains response data for the listByServiceNext operation.

CertificateListByServiceResponse

CertificateListByServiceResponse: CertificateCollection & object

Contains response data for the listByService operation.

ClientAuthenticationMethod

ClientAuthenticationMethod: "Basic" | "Body"

Defines values for ClientAuthenticationMethod. Possible values include: 'Basic', 'Body'

readonly
enum

{string}

Confirmation

Confirmation: "signup" | "invite"

Defines values for Confirmation. Possible values include: 'signup', 'invite'

readonly
enum

{string}

ConnectivityStatusType

ConnectivityStatusType: "initializing" | "success" | "failure"

Defines values for ConnectivityStatusType. Possible values include: 'initializing', 'success', 'failure'

readonly
enum

{string}

ContentFormat

ContentFormat: "wadl-xml" | "wadl-link-json" | "swagger-json" | "swagger-link-json" | "wsdl" | "wsdl-link" | "openapi" | "openapi+json" | "openapi-link"

Defines values for ContentFormat. Possible values include: 'wadl-xml', 'wadl-link-json', 'swagger-json', 'swagger-link-json', 'wsdl', 'wsdl-link', 'openapi', 'openapi+json', 'openapi-link'

readonly
enum

{string}

DelegationSettingsCreateOrUpdateResponse

DelegationSettingsCreateOrUpdateResponse: PortalDelegationSettings & object

Contains response data for the createOrUpdate operation.

DelegationSettingsGetEntityTagResponse

DelegationSettingsGetEntityTagResponse: DelegationSettingsGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

DelegationSettingsGetResponse

DelegationSettingsGetResponse: PortalDelegationSettings & DelegationSettingsGetHeaders & object

Contains response data for the get operation.

DiagnosticCreateOrUpdateResponse

DiagnosticCreateOrUpdateResponse: DiagnosticContract & DiagnosticCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

DiagnosticGetEntityTagResponse

DiagnosticGetEntityTagResponse: DiagnosticGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

DiagnosticGetResponse

DiagnosticGetResponse: DiagnosticContract & DiagnosticGetHeaders & object

Contains response data for the get operation.

DiagnosticListByServiceNextResponse

DiagnosticListByServiceNextResponse: DiagnosticCollection & object

Contains response data for the listByServiceNext operation.

DiagnosticListByServiceResponse

DiagnosticListByServiceResponse: DiagnosticCollection & object

Contains response data for the listByService operation.

EmailTemplateCreateOrUpdateResponse

EmailTemplateCreateOrUpdateResponse: EmailTemplateContract & object

Contains response data for the createOrUpdate operation.

EmailTemplateGetEntityTagResponse

EmailTemplateGetEntityTagResponse: EmailTemplateGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

EmailTemplateGetResponse

EmailTemplateGetResponse: EmailTemplateContract & EmailTemplateGetHeaders & object

Contains response data for the get operation.

EmailTemplateListByServiceNextResponse

EmailTemplateListByServiceNextResponse: EmailTemplateCollection & object

Contains response data for the listByServiceNext operation.

EmailTemplateListByServiceResponse

EmailTemplateListByServiceResponse: EmailTemplateCollection & object

Contains response data for the listByService operation.

ExportFormat

ExportFormat: "swagger-link" | "wsdl-link" | "wadl-link" | "openapi-link"

Defines values for ExportFormat. Possible values include: 'Swagger', 'Wsdl', 'Wadl', 'Openapi'

readonly
enum

{string}

ExportResultFormat

ExportResultFormat: "swagger-link-json" | "wsdl-link+xml" | "wadl-link-json" | "openapi-link"

Defines values for ExportResultFormat. Possible values include: 'Swagger', 'Wsdl', 'Wadl', 'OpenApi'

readonly
enum

{string}

GrantType

GrantType: "authorizationCode" | "implicit" | "resourceOwnerPassword" | "clientCredentials"

Defines values for GrantType. Possible values include: 'authorizationCode', 'implicit', 'resourceOwnerPassword', 'clientCredentials'

readonly
enum

{string}

GroupCreateOrUpdateResponse

GroupCreateOrUpdateResponse: GroupContract & GroupCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

GroupGetEntityTagResponse

GroupGetEntityTagResponse: GroupGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

GroupGetResponse

GroupGetResponse: GroupContract & GroupGetHeaders & object

Contains response data for the get operation.

GroupListByServiceNextResponse

GroupListByServiceNextResponse: GroupCollection & object

Contains response data for the listByServiceNext operation.

GroupListByServiceResponse

GroupListByServiceResponse: GroupCollection & object

Contains response data for the listByService operation.

GroupType

GroupType: "custom" | "system" | "external"

Defines values for GroupType. Possible values include: 'custom', 'system', 'external'

readonly
enum

{string}

GroupUserCheckEntityExistsResponse

GroupUserCheckEntityExistsResponse: object

Contains response data for the checkEntityExists operation.

Type declaration

GroupUserCreateResponse

GroupUserCreateResponse: UserContract & object

Contains response data for the create operation.

GroupUserListNextResponse

GroupUserListNextResponse: UserCollection & object

Contains response data for the listNext operation.

GroupUserListResponse

GroupUserListResponse: UserCollection & object

Contains response data for the list operation.

HostnameType

HostnameType: "Proxy" | "Portal" | "Management" | "Scm" | "DeveloperPortal"

Defines values for HostnameType. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm', 'DeveloperPortal'

readonly
enum

{string}

IdentityProviderCreateOrUpdateResponse

IdentityProviderCreateOrUpdateResponse: IdentityProviderContract & IdentityProviderCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

IdentityProviderGetEntityTagResponse

IdentityProviderGetEntityTagResponse: IdentityProviderGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

IdentityProviderGetResponse

IdentityProviderGetResponse: IdentityProviderContract & IdentityProviderGetHeaders & object

Contains response data for the get operation.

IdentityProviderListByServiceNextResponse

IdentityProviderListByServiceNextResponse: IdentityProviderList & object

Contains response data for the listByServiceNext operation.

IdentityProviderListByServiceResponse

IdentityProviderListByServiceResponse: IdentityProviderList & object

Contains response data for the listByService operation.

IdentityProviderType

IdentityProviderType: "facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C"

Defines values for IdentityProviderType. Possible values include: 'facebook', 'google', 'microsoft', 'twitter', 'aad', 'aadB2C'

readonly
enum

{string}

IssueGetResponse

IssueGetResponse: IssueContract & IssueGetHeaders & object

Contains response data for the get operation.

IssueListByServiceNextResponse

IssueListByServiceNextResponse: IssueCollection & object

Contains response data for the listByServiceNext operation.

IssueListByServiceResponse

IssueListByServiceResponse: IssueCollection & object

Contains response data for the listByService operation.

KeyType

KeyType: "primary" | "secondary"

Defines values for KeyType. Possible values include: 'primary', 'secondary'

readonly
enum

{string}

LoggerCreateOrUpdateResponse

LoggerCreateOrUpdateResponse: LoggerContract & LoggerCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

LoggerGetEntityTagResponse

LoggerGetEntityTagResponse: LoggerGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

LoggerGetResponse

LoggerGetResponse: LoggerContract & LoggerGetHeaders & object

Contains response data for the get operation.

LoggerListByServiceNextResponse

LoggerListByServiceNextResponse: LoggerCollection & object

Contains response data for the listByServiceNext operation.

LoggerListByServiceResponse

LoggerListByServiceResponse: LoggerCollection & object

Contains response data for the listByService operation.

LoggerType

LoggerType: "azureEventHub" | "applicationInsights"

Defines values for LoggerType. Possible values include: 'azureEventHub', 'applicationInsights'

readonly
enum

{string}

NameAvailabilityReason

NameAvailabilityReason: "Valid" | "Invalid" | "AlreadyExists"

Defines values for NameAvailabilityReason. Possible values include: 'Valid', 'Invalid', 'AlreadyExists'

readonly
enum

{string}

NetworkStatusListByLocationResponse

NetworkStatusListByLocationResponse: NetworkStatusContract & object

Contains response data for the listByLocation operation.

NetworkStatusListByServiceResponse

NetworkStatusListByServiceResponse: Array<NetworkStatusContractByLocation> & object

Contains response data for the listByService operation.

NotificationCreateOrUpdateResponse

NotificationCreateOrUpdateResponse: NotificationContract & object

Contains response data for the createOrUpdate operation.

NotificationGetResponse

NotificationGetResponse: NotificationContract & object

Contains response data for the get operation.

NotificationListByServiceNextResponse

NotificationListByServiceNextResponse: NotificationCollection & object

Contains response data for the listByServiceNext operation.

NotificationListByServiceResponse

NotificationListByServiceResponse: NotificationCollection & object

Contains response data for the listByService operation.

NotificationName

NotificationName: "RequestPublisherNotificationMessage" | "PurchasePublisherNotificationMessage" | "NewApplicationNotificationMessage" | "BCC" | "NewIssuePublisherNotificationMessage" | "AccountClosedPublisher" | "QuotaLimitApproachingPublisherNotificationMessage"

Defines values for NotificationName. Possible values include: 'RequestPublisherNotificationMessage', 'PurchasePublisherNotificationMessage', 'NewApplicationNotificationMessage', 'BCC', 'NewIssuePublisherNotificationMessage', 'AccountClosedPublisher', 'QuotaLimitApproachingPublisherNotificationMessage'

readonly
enum

{string}

NotificationRecipientEmailCheckEntityExistsResponse

NotificationRecipientEmailCheckEntityExistsResponse: object

Contains response data for the checkEntityExists operation.

Type declaration

NotificationRecipientEmailCreateOrUpdateResponse

NotificationRecipientEmailCreateOrUpdateResponse: RecipientEmailContract & object

Contains response data for the createOrUpdate operation.

NotificationRecipientEmailListByNotificationResponse

NotificationRecipientEmailListByNotificationResponse: RecipientEmailCollection & object

Contains response data for the listByNotification operation.

NotificationRecipientUserCheckEntityExistsResponse

NotificationRecipientUserCheckEntityExistsResponse: object

Contains response data for the checkEntityExists operation.

Type declaration

NotificationRecipientUserCreateOrUpdateResponse

NotificationRecipientUserCreateOrUpdateResponse: RecipientUserContract & object

Contains response data for the createOrUpdate operation.

NotificationRecipientUserListByNotificationResponse

NotificationRecipientUserListByNotificationResponse: RecipientUserCollection & object

Contains response data for the listByNotification operation.

OpenIdConnectProviderCreateOrUpdateResponse

OpenIdConnectProviderCreateOrUpdateResponse: OpenidConnectProviderContract & OpenIdConnectProviderCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

OpenIdConnectProviderGetEntityTagResponse

OpenIdConnectProviderGetEntityTagResponse: OpenIdConnectProviderGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

OpenIdConnectProviderGetResponse

OpenIdConnectProviderGetResponse: OpenidConnectProviderContract & OpenIdConnectProviderGetHeaders & object

Contains response data for the get operation.

OpenIdConnectProviderListByServiceNextResponse

OpenIdConnectProviderListByServiceNextResponse: OpenIdConnectProviderCollection & object

Contains response data for the listByServiceNext operation.

OpenIdConnectProviderListByServiceResponse

OpenIdConnectProviderListByServiceResponse: OpenIdConnectProviderCollection & object

Contains response data for the listByService operation.

OperationListByTagsNextResponse

OperationListByTagsNextResponse: TagResourceCollection & object

Contains response data for the listByTagsNext operation.

OperationListByTagsResponse

OperationListByTagsResponse: TagResourceCollection & object

Contains response data for the listByTags operation.

PolicyContentFormat

PolicyContentFormat: "xml" | "xml-link" | "rawxml" | "rawxml-link"

Defines values for PolicyContentFormat. Possible values include: 'xml', 'xml-link', 'rawxml', 'rawxml-link'

readonly
enum

{string}

PolicyCreateOrUpdateResponse

PolicyCreateOrUpdateResponse: PolicyContract & PolicyCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

PolicyExportFormat

PolicyExportFormat: "xml" | "rawxml"

Defines values for PolicyExportFormat. Possible values include: 'xml', 'rawxml'

readonly
enum

{string}

PolicyGetEntityTagResponse

PolicyGetEntityTagResponse: PolicyGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

PolicyGetResponse

PolicyGetResponse: PolicyContract & PolicyGetHeaders & object

Contains response data for the get operation.

PolicyListByServiceResponse

PolicyListByServiceResponse: PolicyCollection & object

Contains response data for the listByService operation.

PolicyScopeContract

PolicyScopeContract: "Tenant" | "Product" | "Api" | "Operation" | "All"

Defines values for PolicyScopeContract. Possible values include: 'Tenant', 'Product', 'Api', 'Operation', 'All'

readonly
enum

{string}

PolicySnippetListByServiceResponse

PolicySnippetListByServiceResponse: PolicySnippetsCollection & object

Contains response data for the listByService operation.

ProductApiCreateOrUpdateResponse

ProductApiCreateOrUpdateResponse: ApiContract & object

Contains response data for the createOrUpdate operation.

ProductApiListByProductNextResponse

ProductApiListByProductNextResponse: ApiCollection & object

Contains response data for the listByProductNext operation.

ProductApiListByProductResponse

ProductApiListByProductResponse: ApiCollection & object

Contains response data for the listByProduct operation.

ProductCreateOrUpdateResponse

ProductCreateOrUpdateResponse: ProductContract & ProductCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ProductGetEntityTagResponse

ProductGetEntityTagResponse: ProductGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ProductGetResponse

ProductGetResponse: ProductContract & ProductGetHeaders & object

Contains response data for the get operation.

ProductGroupCreateOrUpdateResponse

ProductGroupCreateOrUpdateResponse: GroupContract & object

Contains response data for the createOrUpdate operation.

ProductGroupListByProductNextResponse

ProductGroupListByProductNextResponse: GroupCollection & object

Contains response data for the listByProductNext operation.

ProductGroupListByProductResponse

ProductGroupListByProductResponse: GroupCollection & object

Contains response data for the listByProduct operation.

ProductListByServiceNextResponse

ProductListByServiceNextResponse: ProductCollection & object

Contains response data for the listByServiceNext operation.

ProductListByServiceResponse

ProductListByServiceResponse: ProductCollection & object

Contains response data for the listByService operation.

ProductListByTagsNextResponse

ProductListByTagsNextResponse: TagResourceCollection & object

Contains response data for the listByTagsNext operation.

ProductListByTagsResponse

ProductListByTagsResponse: TagResourceCollection & object

Contains response data for the listByTags operation.

ProductPolicyCreateOrUpdateResponse

ProductPolicyCreateOrUpdateResponse: PolicyContract & ProductPolicyCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

ProductPolicyGetEntityTagResponse

ProductPolicyGetEntityTagResponse: ProductPolicyGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

ProductPolicyGetResponse

ProductPolicyGetResponse: PolicyContract & ProductPolicyGetHeaders & object

Contains response data for the get operation.

ProductPolicyListByProductResponse

ProductPolicyListByProductResponse: PolicyCollection & object

Contains response data for the listByProduct operation.

ProductState

ProductState: "notPublished" | "published"

Defines values for ProductState. Possible values include: 'notPublished', 'published'

readonly
enum

{string}

ProductSubscriptionsListNextResponse

ProductSubscriptionsListNextResponse: SubscriptionCollection & object

Contains response data for the listNext operation.

ProductSubscriptionsListResponse

ProductSubscriptionsListResponse: SubscriptionCollection & object

Contains response data for the list operation.

PropertyCreateOrUpdateResponse

PropertyCreateOrUpdateResponse: PropertyContract & PropertyCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

PropertyGetEntityTagResponse

PropertyGetEntityTagResponse: PropertyGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

PropertyGetResponse

PropertyGetResponse: PropertyContract & PropertyGetHeaders & object

Contains response data for the get operation.

PropertyListByServiceNextResponse

PropertyListByServiceNextResponse: PropertyCollection & object

Contains response data for the listByServiceNext operation.

PropertyListByServiceResponse

PropertyListByServiceResponse: PropertyCollection & object

Contains response data for the listByService operation.

Protocol

Protocol: "http" | "https"

Defines values for Protocol. Possible values include: 'http', 'https'

readonly
enum

{string}

QuotaByCounterKeysListByServiceResponse

QuotaByCounterKeysListByServiceResponse: QuotaCounterCollection & object

Contains response data for the listByService operation.

QuotaByPeriodKeysGetResponse

QuotaByPeriodKeysGetResponse: QuotaCounterContract & object

Contains response data for the get operation.

RegionListByServiceNextResponse

RegionListByServiceNextResponse: RegionListResult & object

Contains response data for the listByServiceNext operation.

RegionListByServiceResponse

RegionListByServiceResponse: RegionListResult & object

Contains response data for the listByService operation.

ReportsListByApiNextResponse

ReportsListByApiNextResponse: ReportCollection & object

Contains response data for the listByApiNext operation.

ReportsListByApiResponse

ReportsListByApiResponse: ReportCollection & object

Contains response data for the listByApi operation.

ReportsListByGeoNextResponse

ReportsListByGeoNextResponse: ReportCollection & object

Contains response data for the listByGeoNext operation.

ReportsListByGeoResponse

ReportsListByGeoResponse: ReportCollection & object

Contains response data for the listByGeo operation.

ReportsListByOperationNextResponse

ReportsListByOperationNextResponse: ReportCollection & object

Contains response data for the listByOperationNext operation.

ReportsListByOperationResponse

ReportsListByOperationResponse: ReportCollection & object

Contains response data for the listByOperation operation.

ReportsListByProductNextResponse

ReportsListByProductNextResponse: ReportCollection & object

Contains response data for the listByProductNext operation.

ReportsListByProductResponse

ReportsListByProductResponse: ReportCollection & object

Contains response data for the listByProduct operation.

ReportsListByRequestResponse

ReportsListByRequestResponse: RequestReportCollection & object

Contains response data for the listByRequest operation.

ReportsListBySubscriptionNextResponse

ReportsListBySubscriptionNextResponse: ReportCollection & object

Contains response data for the listBySubscriptionNext operation.

ReportsListBySubscriptionResponse

ReportsListBySubscriptionResponse: ReportCollection & object

Contains response data for the listBySubscription operation.

ReportsListByTimeNextResponse

ReportsListByTimeNextResponse: ReportCollection & object

Contains response data for the listByTimeNext operation.

ReportsListByTimeResponse

ReportsListByTimeResponse: ReportCollection & object

Contains response data for the listByTime operation.

ReportsListByUserNextResponse

ReportsListByUserNextResponse: ReportCollection & object

Contains response data for the listByUserNext operation.

ReportsListByUserResponse

ReportsListByUserResponse: ReportCollection & object

Contains response data for the listByUser operation.

ResourceSkuCapacityScaleType

ResourceSkuCapacityScaleType: "automatic" | "manual" | "none"

Defines values for ResourceSkuCapacityScaleType. Possible values include: 'automatic', 'manual', 'none'

readonly
enum

{string}

SamplingType

SamplingType: "fixed"

Defines values for SamplingType. Possible values include: 'fixed'

readonly
enum

{string}

SignInSettingsCreateOrUpdateResponse

SignInSettingsCreateOrUpdateResponse: PortalSigninSettings & object

Contains response data for the createOrUpdate operation.

SignInSettingsGetEntityTagResponse

SignInSettingsGetEntityTagResponse: SignInSettingsGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

SignInSettingsGetResponse

SignInSettingsGetResponse: PortalSigninSettings & SignInSettingsGetHeaders & object

Contains response data for the get operation.

SignUpSettingsCreateOrUpdateResponse

SignUpSettingsCreateOrUpdateResponse: PortalSignupSettings & object

Contains response data for the createOrUpdate operation.

SignUpSettingsGetEntityTagResponse

SignUpSettingsGetEntityTagResponse: SignUpSettingsGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

SignUpSettingsGetResponse

SignUpSettingsGetResponse: PortalSignupSettings & SignUpSettingsGetHeaders & object

Contains response data for the get operation.

SkuType

SkuType: "Developer" | "Standard" | "Premium" | "Basic" | "Consumption"

Defines values for SkuType. Possible values include: 'Developer', 'Standard', 'Premium', 'Basic', 'Consumption'

readonly
enum

{string}

SoapApiType

SoapApiType: "http" | "soap"

Defines values for SoapApiType. Possible values include: 'SoapToRest', 'SoapPassThrough'

readonly
enum

{string}

State

State: "proposed" | "open" | "removed" | "resolved" | "closed"

Defines values for State. Possible values include: 'proposed', 'open', 'removed', 'resolved', 'closed'

readonly
enum

{string}

StoreName

StoreName: "CertificateAuthority" | "Root"

Defines values for StoreName. Possible values include: 'CertificateAuthority', 'Root'

readonly
enum

{string}

SubscriptionCreateOrUpdateResponse

SubscriptionCreateOrUpdateResponse: SubscriptionContract & SubscriptionCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

SubscriptionGetEntityTagResponse

SubscriptionGetEntityTagResponse: SubscriptionGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

SubscriptionGetResponse

SubscriptionGetResponse: SubscriptionContract & SubscriptionGetHeaders & object

Contains response data for the get operation.

SubscriptionListNextResponse

SubscriptionListNextResponse: SubscriptionCollection & object

Contains response data for the listNext operation.

SubscriptionListResponse

SubscriptionListResponse: SubscriptionCollection & object

Contains response data for the list operation.

SubscriptionState

SubscriptionState: "suspended" | "active" | "expired" | "submitted" | "rejected" | "cancelled"

Defines values for SubscriptionState. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'

readonly
enum

{string}

TagAssignToApiResponse

TagAssignToApiResponse: TagContract & TagAssignToApiHeaders & object

Contains response data for the assignToApi operation.

TagAssignToOperationResponse

TagAssignToOperationResponse: TagContract & object

Contains response data for the assignToOperation operation.

TagAssignToProductResponse

TagAssignToProductResponse: TagContract & object

Contains response data for the assignToProduct operation.

TagCreateOrUpdateResponse

TagCreateOrUpdateResponse: TagContract & TagCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

TagGetByApiResponse

TagGetByApiResponse: TagContract & TagGetByApiHeaders & object

Contains response data for the getByApi operation.

TagGetByOperationResponse

TagGetByOperationResponse: TagContract & TagGetByOperationHeaders & object

Contains response data for the getByOperation operation.

TagGetByProductResponse

TagGetByProductResponse: TagContract & TagGetByProductHeaders & object

Contains response data for the getByProduct operation.

TagGetEntityStateByApiResponse

TagGetEntityStateByApiResponse: TagGetEntityStateByApiHeaders & object

Contains response data for the getEntityStateByApi operation.

TagGetEntityStateByOperationResponse

TagGetEntityStateByOperationResponse: TagGetEntityStateByOperationHeaders & object

Contains response data for the getEntityStateByOperation operation.

TagGetEntityStateByProductResponse

TagGetEntityStateByProductResponse: TagGetEntityStateByProductHeaders & object

Contains response data for the getEntityStateByProduct operation.

TagGetEntityStateResponse

TagGetEntityStateResponse: TagGetEntityStateHeaders & object

Contains response data for the getEntityState operation.

TagGetResponse

TagGetResponse: TagContract & TagGetHeaders & object

Contains response data for the get operation.

TagListByApiNextResponse

TagListByApiNextResponse: TagCollection & object

Contains response data for the listByApiNext operation.

TagListByApiResponse

TagListByApiResponse: TagCollection & object

Contains response data for the listByApi operation.

TagListByOperationNextResponse

TagListByOperationNextResponse: TagCollection & object

Contains response data for the listByOperationNext operation.

TagListByOperationResponse

TagListByOperationResponse: TagCollection & object

Contains response data for the listByOperation operation.

TagListByProductNextResponse

TagListByProductNextResponse: TagCollection & object

Contains response data for the listByProductNext operation.

TagListByProductResponse

TagListByProductResponse: TagCollection & object

Contains response data for the listByProduct operation.

TagListByServiceNextResponse

TagListByServiceNextResponse: TagCollection & object

Contains response data for the listByServiceNext operation.

TagListByServiceResponse

TagListByServiceResponse: TagCollection & object

Contains response data for the listByService operation.

TagResourceListByServiceNextResponse

TagResourceListByServiceNextResponse: TagResourceCollection & object

Contains response data for the listByServiceNext operation.

TagResourceListByServiceResponse

TagResourceListByServiceResponse: TagResourceCollection & object

Contains response data for the listByService operation.

TemplateName

TemplateName: "applicationApprovedNotificationMessage" | "accountClosedDeveloper" | "quotaLimitApproachingDeveloperNotificationMessage" | "newDeveloperNotificationMessage" | "emailChangeIdentityDefault" | "inviteUserNotificationMessage" | "newCommentNotificationMessage" | "confirmSignUpIdentityDefault" | "newIssueNotificationMessage" | "purchaseDeveloperNotificationMessage" | "passwordResetIdentityDefault" | "passwordResetByAdminNotificationMessage" | "rejectDeveloperNotificationMessage" | "requestDeveloperNotificationMessage"

Defines values for TemplateName. Possible values include: 'applicationApprovedNotificationMessage', 'accountClosedDeveloper', 'quotaLimitApproachingDeveloperNotificationMessage', 'newDeveloperNotificationMessage', 'emailChangeIdentityDefault', 'inviteUserNotificationMessage', 'newCommentNotificationMessage', 'confirmSignUpIdentityDefault', 'newIssueNotificationMessage', 'purchaseDeveloperNotificationMessage', 'passwordResetIdentityDefault', 'passwordResetByAdminNotificationMessage', 'rejectDeveloperNotificationMessage', 'requestDeveloperNotificationMessage'

readonly
enum

{string}

TenantAccessGetEntityTagResponse

TenantAccessGetEntityTagResponse: TenantAccessGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

TenantAccessGetResponse

TenantAccessGetResponse: AccessInformationContract & TenantAccessGetHeaders & object

Contains response data for the get operation.

TenantAccessGitGetResponse

TenantAccessGitGetResponse: AccessInformationContract & TenantAccessGitGetHeaders & object

Contains response data for the get operation.

TenantConfigurationBeginDeployResponse

TenantConfigurationBeginDeployResponse: OperationResultContract & object

Contains response data for the beginDeploy operation.

TenantConfigurationBeginSaveResponse

TenantConfigurationBeginSaveResponse: OperationResultContract & object

Contains response data for the beginSave operation.

TenantConfigurationBeginValidateResponse

TenantConfigurationBeginValidateResponse: OperationResultContract & object

Contains response data for the beginValidate operation.

TenantConfigurationDeployResponse

TenantConfigurationDeployResponse: OperationResultContract & object

Contains response data for the deploy operation.

TenantConfigurationGetSyncStateResponse

TenantConfigurationGetSyncStateResponse: TenantConfigurationSyncStateContract & object

Contains response data for the getSyncState operation.

TenantConfigurationSaveResponse

TenantConfigurationSaveResponse: OperationResultContract & object

Contains response data for the save operation.

TenantConfigurationValidateResponse

TenantConfigurationValidateResponse: OperationResultContract & object

Contains response data for the validate operation.

UserCreateOrUpdateResponse

UserCreateOrUpdateResponse: UserContract & UserCreateOrUpdateHeaders & object

Contains response data for the createOrUpdate operation.

UserGenerateSsoUrlResponse

UserGenerateSsoUrlResponse: GenerateSsoUrlResult & object

Contains response data for the generateSsoUrl operation.

UserGetEntityTagResponse

UserGetEntityTagResponse: UserGetEntityTagHeaders & object

Contains response data for the getEntityTag operation.

UserGetResponse

UserGetResponse: UserContract & UserGetHeaders & object

Contains response data for the get operation.

UserGetSharedAccessTokenResponse

UserGetSharedAccessTokenResponse: UserTokenResult & object

Contains response data for the getSharedAccessToken operation.

UserGroupListNextResponse

UserGroupListNextResponse: GroupCollection & object

Contains response data for the listNext operation.

UserGroupListResponse

UserGroupListResponse: GroupCollection & object

Contains response data for the list operation.

UserIdentitiesListNextResponse

UserIdentitiesListNextResponse: UserIdentityCollection & object

Contains response data for the listNext operation.

UserIdentitiesListResponse

UserIdentitiesListResponse: UserIdentityCollection & object

Contains response data for the list operation.

UserListByServiceNextResponse

UserListByServiceNextResponse: UserCollection & object

Contains response data for the listByServiceNext operation.

UserListByServiceResponse

UserListByServiceResponse: UserCollection & object

Contains response data for the listByService operation.

UserState

UserState: "active" | "blocked" | "pending" | "deleted"

Defines values for UserState. Possible values include: 'active', 'blocked', 'pending', 'deleted'

readonly
enum

{string}

UserSubscriptionListNextResponse

UserSubscriptionListNextResponse: SubscriptionCollection & object

Contains response data for the listNext operation.

UserSubscriptionListResponse

UserSubscriptionListResponse: SubscriptionCollection & object

Contains response data for the list operation.

VersioningScheme

VersioningScheme: "Segment" | "Query" | "Header"

Defines values for VersioningScheme. Possible values include: 'Segment', 'Query', 'Header'

readonly
enum

{string}

VersioningScheme1

VersioningScheme1: "Segment" | "Query" | "Header"

Defines values for VersioningScheme1. Possible values include: 'Segment', 'Query', 'Header'

readonly
enum

{string}

VirtualNetworkType

VirtualNetworkType: "None" | "External" | "Internal"

Defines values for VirtualNetworkType. Possible values include: 'None', 'External', 'Internal'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AccessInformationContract

AccessInformationContract: object

Tenant access information contract of the API Management service.

Optional enabled

enabled: undefined | false | true

Determines whether direct access is enabled.

Optional id

id: undefined | string

Identifier.

Optional primaryKey

primaryKey: undefined | string

Primary access key.

Optional secondaryKey

secondaryKey: undefined | string

Secondary access key.

serializedName

serializedName: string = "AccessInformationContract"

type

type: object

className

className: string = "AccessInformationContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

primaryKey

primaryKey: object

serializedName

serializedName: string = "primaryKey"

type

type: object

name

name: "String" = "String"

secondaryKey

secondaryKey: object

serializedName

serializedName: string = "secondaryKey"

type

type: object

name

name: "String" = "String"

Const AccessInformationUpdateParameters

AccessInformationUpdateParameters: object

Tenant access information update parameters.

Optional enabled

enabled: undefined | false | true

Determines whether direct access is enabled.

serializedName

serializedName: string = "AccessInformationUpdateParameters"

type

type: object

className

className: string = "AccessInformationUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const AdditionalLocation

AdditionalLocation: object

Description of an additional API Management resource location.

Optional gatewayRegionalUrl

gatewayRegionalUrl: undefined | string

Gateway URL of the API Management service in the Region. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

The location name of the additional region among Azure Data center regions.

Optional privateIPAddresses

privateIPAddresses: string[]

Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard and Premium SKU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicIPAddresses

publicIPAddresses: string[]

Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU. NOTE: This property will not be serialized. It can only be populated by the server.

sku

sku: ApiManagementServiceSkuProperties

SKU properties of the API Management service.

Optional virtualNetworkConfiguration

virtualNetworkConfiguration: VirtualNetworkConfiguration

Virtual network configuration for the location.

serializedName

serializedName: string = "AdditionalLocation"

type

type: object

className

className: string = "AdditionalLocation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

gatewayRegionalUrl

gatewayRegionalUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "gatewayRegionalUrl"

type

type: object

name

name: "String" = "String"

location

location: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

privateIPAddresses

privateIPAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "privateIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

publicIPAddresses

publicIPAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "publicIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

sku

sku: object

required

required: true = true

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "ApiManagementServiceSkuProperties"

name

name: "Composite" = "Composite"

virtualNetworkConfiguration

virtualNetworkConfiguration: object

serializedName

serializedName: string = "virtualNetworkConfiguration"

type

type: object

className

className: string = "VirtualNetworkConfiguration"

name

name: "Composite" = "Composite"

Const ApiCollection

ApiCollection: object
interface

Paged Api list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApiCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ApiContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ApiContract>[]

      Additional items to add to the end of array1.

    Returns ApiContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApiContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApiContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ApiContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApiContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ApiContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ApiContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApiContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ApiContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ApiContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApiContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ApiContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApiContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ApiContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApiContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ApiContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ApiContract[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ApiContract

  • Parameters

    Returns ApiContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ApiContract
  • reduceRight(callbackfn: function, initialValue: ApiContract): ApiContract
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ApiContract

  • Parameters

    Returns ApiContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ApiContract[]

shift

  • Removes the first element from an array and returns it.

    Returns ApiContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ApiContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApiContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApiContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApiContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApiContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ApiContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ApiContract>

type

type: object

className

className: string = "ApiCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApiContract"

name

name: "Composite" = "Composite"

Const ApiContract

ApiContract: object

Api details.

Optional apiRevision

apiRevision: undefined | string

Describes the Revision of the Api. If no value is provided, default revision 1 is created

Optional apiRevisionDescription

apiRevisionDescription: undefined | string

Description of the Api Revision.

Optional apiType

apiType: ApiType

Type of API. Possible values include: 'http', 'soap'

Optional apiVersion

apiVersion: undefined | string

Indicates the Version identifier of the API if the API is versioned

Optional apiVersionDescription

apiVersionDescription: undefined | string

Description of the Api Version.

Optional apiVersionSet

apiVersionSet: ApiVersionSetContractDetails

Version set details

Optional apiVersionSetId

apiVersionSetId: undefined | string

A resource identifier for the related ApiVersionSet.

Optional authenticationSettings

authenticationSettings: AuthenticationSettingsContract

Collection of authentication settings included into this API.

Optional description

description: undefined | string

Description of the API. May include HTML formatting tags.

Optional displayName

displayName: undefined | string

API name. Must be 1 to 300 characters long.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isCurrent

isCurrent: undefined | false | true

Indicates if API revision is current api revision.

Optional isOnline

isOnline: undefined | false | true

Indicates if API revision is accessible via the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

path

path: string

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Optional protocols

protocols: Protocol[]

Describes on which protocols the operations in this API can be invoked.

Optional serviceUrl

serviceUrl: undefined | string

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

Optional sourceApiId

sourceApiId: undefined | string

API identifier of the source API.

Optional subscriptionKeyParameterNames

subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContract

Protocols over which API is made available.

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Specifies whether an API or Product subscription is required for accessing the API.

serializedName

serializedName: string = "ApiContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ApiContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiRevision

apiRevision: object

serializedName

serializedName: string = "properties.apiRevision"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

apiRevisionDescription

apiRevisionDescription: object

serializedName

serializedName: string = "properties.apiRevisionDescription"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

apiType

apiType: object

serializedName

serializedName: string = "properties.type"

type

type: object

name

name: "String" = "String"

apiVersion

apiVersion: object

serializedName

serializedName: string = "properties.apiVersion"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

apiVersionDescription

apiVersionDescription: object

serializedName

serializedName: string = "properties.apiVersionDescription"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

apiVersionSet

apiVersionSet: object

serializedName

serializedName: string = "properties.apiVersionSet"

type

type: object

className

className: string = "ApiVersionSetContractDetails"

name

name: "Composite" = "Composite"

apiVersionSetId

apiVersionSetId: object

serializedName

serializedName: string = "properties.apiVersionSetId"

type

type: object

name

name: "String" = "String"

authenticationSettings

authenticationSettings: object

serializedName

serializedName: string = "properties.authenticationSettings"

type

type: object

className

className: string = "AuthenticationSettingsContract"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

isCurrent

isCurrent: object

serializedName

serializedName: string = "properties.isCurrent"

type

type: object

name

name: "Boolean" = "Boolean"

isOnline

isOnline: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isOnline"

type

type: object

name

name: "Boolean" = "Boolean"

path

path: object

required

required: true = true

serializedName

serializedName: string = "properties.path"

constraints

constraints: object

MaxLength

MaxLength: number = 400

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

protocols

protocols: object

serializedName

serializedName: string = "properties.protocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["http","https"]

name

name: "Enum" = "Enum"

serviceUrl

serviceUrl: object

serializedName

serializedName: string = "properties.serviceUrl"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

sourceApiId

sourceApiId: object

serializedName

serializedName: string = "properties.sourceApiId"

type

type: object

name

name: "String" = "String"

subscriptionKeyParameterNames

subscriptionKeyParameterNames: object

serializedName

serializedName: string = "properties.subscriptionKeyParameterNames"

type

type: object

className

className: string = "SubscriptionKeyParameterNamesContract"

name

name: "Composite" = "Composite"

subscriptionRequired

subscriptionRequired: object

serializedName

serializedName: string = "properties.subscriptionRequired"

type

type: object

name

name: "Boolean" = "Boolean"

Const ApiContractProperties

ApiContractProperties: object

Api Entity Properties

Optional apiRevision

apiRevision: undefined | string

Describes the Revision of the Api. If no value is provided, default revision 1 is created

Optional apiRevisionDescription

apiRevisionDescription: undefined | string

Description of the Api Revision.

Optional apiType

apiType: ApiType

Type of API. Possible values include: 'http', 'soap'

Optional apiVersion

apiVersion: undefined | string

Indicates the Version identifier of the API if the API is versioned

Optional apiVersionDescription

apiVersionDescription: undefined | string

Description of the Api Version.

Optional apiVersionSet

apiVersionSet: ApiVersionSetContractDetails

Version set details

Optional apiVersionSetId

apiVersionSetId: undefined | string

A resource identifier for the related ApiVersionSet.

Optional authenticationSettings

authenticationSettings: AuthenticationSettingsContract

Collection of authentication settings included into this API.

Optional description

description: undefined | string

Description of the API. May include HTML formatting tags.

Optional displayName

displayName: undefined | string

API name. Must be 1 to 300 characters long.

Optional isCurrent

isCurrent: undefined | false | true

Indicates if API revision is current api revision.

Optional isOnline

isOnline: undefined | false | true

Indicates if API revision is accessible via the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

path

path: string

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Optional protocols

protocols: Protocol[]

Describes on which protocols the operations in this API can be invoked.

Optional serviceUrl

serviceUrl: undefined | string

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

Optional sourceApiId

sourceApiId: undefined | string

API identifier of the source API.

Optional subscriptionKeyParameterNames

subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContract

Protocols over which API is made available.

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Specifies whether an API or Product subscription is required for accessing the API.

serializedName

serializedName: string = "ApiContractProperties"

type

type: object

className

className: string = "ApiContractProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiVersionSet

apiVersionSet: object

serializedName

serializedName: string = "apiVersionSet"

type

type: object

className

className: string = "ApiVersionSetContractDetails"

name

name: "Composite" = "Composite"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

path

path: object

required

required: true = true

serializedName

serializedName: string = "path"

constraints

constraints: object

MaxLength

MaxLength: number = 400

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

protocols

protocols: object

serializedName

serializedName: string = "protocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["http","https"]

name

name: "Enum" = "Enum"

serviceUrl

serviceUrl: object

serializedName

serializedName: string = "serviceUrl"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

sourceApiId

sourceApiId: object

serializedName

serializedName: string = "sourceApiId"

type

type: object

name

name: "String" = "String"

Const ApiCreateOrUpdateHeaders

ApiCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "api-createorupdate-headers"

type

type: object

className

className: string = "ApiCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiCreateOrUpdateParameter

ApiCreateOrUpdateParameter: object

API Create or Update Parameters.

Optional apiRevision

apiRevision: undefined | string

Describes the Revision of the Api. If no value is provided, default revision 1 is created

Optional apiRevisionDescription

apiRevisionDescription: undefined | string

Description of the Api Revision.

Optional apiType

apiType: ApiType

Type of API. Possible values include: 'http', 'soap'

Optional apiVersion

apiVersion: undefined | string

Indicates the Version identifier of the API if the API is versioned

Optional apiVersionDescription

apiVersionDescription: undefined | string

Description of the Api Version.

Optional apiVersionSet

apiVersionSet: ApiVersionSetContractDetails

Version set details

Optional apiVersionSetId

apiVersionSetId: undefined | string

A resource identifier for the related ApiVersionSet.

Optional authenticationSettings

authenticationSettings: AuthenticationSettingsContract

Collection of authentication settings included into this API.

Optional description

description: undefined | string

Description of the API. May include HTML formatting tags.

Optional displayName

displayName: undefined | string

API name. Must be 1 to 300 characters long.

Optional format

format: ContentFormat

Format of the Content in which the API is getting imported. Possible values include: 'wadl-xml', 'wadl-link-json', 'swagger-json', 'swagger-link-json', 'wsdl', 'wsdl-link', 'openapi', 'openapi+json', 'openapi-link'

Optional isCurrent

isCurrent: undefined | false | true

Indicates if API revision is current api revision.

Optional isOnline

isOnline: undefined | false | true

Indicates if API revision is accessible via the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

path

path: string

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Optional protocols

protocols: Protocol[]

Describes on which protocols the operations in this API can be invoked.

Optional serviceUrl

serviceUrl: undefined | string

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

Optional soapApiType

soapApiType: SoapApiType

Type of Api to create.

  • http creates a SOAP to REST API
  • soap creates a SOAP pass-through API. Possible values include: 'SoapToRest', 'SoapPassThrough'

Optional sourceApiId

sourceApiId: undefined | string

API identifier of the source API.

Optional subscriptionKeyParameterNames

subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContract

Protocols over which API is made available.

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Specifies whether an API or Product subscription is required for accessing the API.

Optional value

value: undefined | string

Content value when Importing an API.

Optional wsdlSelector

wsdlSelector: ApiCreateOrUpdatePropertiesWsdlSelector

Criteria to limit import of WSDL to a subset of the document.

serializedName

serializedName: string = "ApiCreateOrUpdateParameter"

type

type: object

className

className: string = "ApiCreateOrUpdateParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiRevision

apiRevision: object

serializedName

serializedName: string = "properties.apiRevision"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

apiRevisionDescription

apiRevisionDescription: object

serializedName

serializedName: string = "properties.apiRevisionDescription"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

apiType

apiType: object

serializedName

serializedName: string = "properties.type"

type

type: object

name

name: "String" = "String"

apiVersion

apiVersion: object

serializedName

serializedName: string = "properties.apiVersion"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

apiVersionDescription

apiVersionDescription: object

serializedName

serializedName: string = "properties.apiVersionDescription"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

apiVersionSet

apiVersionSet: object

serializedName

serializedName: string = "properties.apiVersionSet"

type

type: object

className

className: string = "ApiVersionSetContractDetails"

name

name: "Composite" = "Composite"

apiVersionSetId

apiVersionSetId: object

serializedName

serializedName: string = "properties.apiVersionSetId"

type

type: object

name

name: "String" = "String"

authenticationSettings

authenticationSettings: object

serializedName

serializedName: string = "properties.authenticationSettings"

type

type: object

className

className: string = "AuthenticationSettingsContract"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

format

format: object

serializedName

serializedName: string = "properties.format"

type

type: object

name

name: "String" = "String"

isCurrent

isCurrent: object

serializedName

serializedName: string = "properties.isCurrent"

type

type: object

name

name: "Boolean" = "Boolean"

isOnline

isOnline: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isOnline"

type

type: object

name

name: "Boolean" = "Boolean"

path

path: object

required

required: true = true

serializedName

serializedName: string = "properties.path"

constraints

constraints: object

MaxLength

MaxLength: number = 400

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

protocols

protocols: object

serializedName

serializedName: string = "properties.protocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["http","https"]

name

name: "Enum" = "Enum"

serviceUrl

serviceUrl: object

serializedName

serializedName: string = "properties.serviceUrl"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

soapApiType

soapApiType: object

serializedName

serializedName: string = "properties.apiType"

type

type: object

name

name: "String" = "String"

sourceApiId

sourceApiId: object

serializedName

serializedName: string = "properties.sourceApiId"

type

type: object

name

name: "String" = "String"

subscriptionKeyParameterNames

subscriptionKeyParameterNames: object

serializedName

serializedName: string = "properties.subscriptionKeyParameterNames"

type

type: object

className

className: string = "SubscriptionKeyParameterNamesContract"

name

name: "Composite" = "Composite"

subscriptionRequired

subscriptionRequired: object

serializedName

serializedName: string = "properties.subscriptionRequired"

type

type: object

name

name: "Boolean" = "Boolean"

value

value: object

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "String" = "String"

wsdlSelector

wsdlSelector: object

serializedName

serializedName: string = "properties.wsdlSelector"

type

type: object

className

className: string = "ApiCreateOrUpdatePropertiesWsdlSelector"

name

name: "Composite" = "Composite"

Const ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector: object

Criteria to limit import of WSDL to a subset of the document.

Optional wsdlEndpointName

wsdlEndpointName: undefined | string

Name of endpoint(port) to import from WSDL

Optional wsdlServiceName

wsdlServiceName: undefined | string

Name of service to import from WSDL

serializedName

serializedName: string = "ApiCreateOrUpdateProperties_wsdlSelector"

type

type: object

className

className: string = "ApiCreateOrUpdatePropertiesWsdlSelector"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

wsdlEndpointName

wsdlEndpointName: object

serializedName

serializedName: string = "wsdlEndpointName"

type

type: object

name

name: "String" = "String"

wsdlServiceName

wsdlServiceName: object

serializedName

serializedName: string = "wsdlServiceName"

type

type: object

name

name: "String" = "String"

Const ApiDiagnosticCreateOrUpdateHeaders

ApiDiagnosticCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apidiagnostic-createorupdate-headers"

type

type: object

className

className: string = "ApiDiagnosticCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiDiagnosticGetEntityTagHeaders

ApiDiagnosticGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apidiagnostic-getentitytag-headers"

type

type: object

className

className: string = "ApiDiagnosticGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiDiagnosticGetHeaders

ApiDiagnosticGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apidiagnostic-get-headers"

type

type: object

className

className: string = "ApiDiagnosticGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiEntityBaseContract

ApiEntityBaseContract: object

API base contract details.

Optional apiRevision

apiRevision: undefined | string

Describes the Revision of the Api. If no value is provided, default revision 1 is created

Optional apiRevisionDescription

apiRevisionDescription: undefined | string

Description of the Api Revision.

Optional apiType

apiType: ApiType

Type of API. Possible values include: 'http', 'soap'

Optional apiVersion

apiVersion: undefined | string

Indicates the Version identifier of the API if the API is versioned

Optional apiVersionDescription

apiVersionDescription: undefined | string

Description of the Api Version.

Optional apiVersionSetId

apiVersionSetId: undefined | string

A resource identifier for the related ApiVersionSet.

Optional authenticationSettings

authenticationSettings: AuthenticationSettingsContract

Collection of authentication settings included into this API.

Optional description

description: undefined | string

Description of the API. May include HTML formatting tags.

Optional isCurrent

isCurrent: undefined | false | true

Indicates if API revision is current api revision.

Optional isOnline

isOnline: undefined | false | true

Indicates if API revision is accessible via the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscriptionKeyParameterNames

subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContract

Protocols over which API is made available.

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Specifies whether an API or Product subscription is required for accessing the API.

serializedName

serializedName: string = "ApiEntityBaseContract"

type

type: object

className

className: string = "ApiEntityBaseContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiRevision

apiRevision: object

serializedName

serializedName: string = "apiRevision"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

apiRevisionDescription

apiRevisionDescription: object

serializedName

serializedName: string = "apiRevisionDescription"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

apiType

apiType: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

apiVersion

apiVersion: object

serializedName

serializedName: string = "apiVersion"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

apiVersionDescription

apiVersionDescription: object

serializedName

serializedName: string = "apiVersionDescription"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

apiVersionSetId

apiVersionSetId: object

serializedName

serializedName: string = "apiVersionSetId"

type

type: object

name

name: "String" = "String"

authenticationSettings

authenticationSettings: object

serializedName

serializedName: string = "authenticationSettings"

type

type: object

className

className: string = "AuthenticationSettingsContract"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

isCurrent

isCurrent: object

serializedName

serializedName: string = "isCurrent"

type

type: object

name

name: "Boolean" = "Boolean"

isOnline

isOnline: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "isOnline"

type

type: object

name

name: "Boolean" = "Boolean"

subscriptionKeyParameterNames

subscriptionKeyParameterNames: object

serializedName

serializedName: string = "subscriptionKeyParameterNames"

type

type: object

className

className: string = "SubscriptionKeyParameterNamesContract"

name

name: "Composite" = "Composite"

subscriptionRequired

subscriptionRequired: object

serializedName

serializedName: string = "subscriptionRequired"

type

type: object

name

name: "Boolean" = "Boolean"

Const ApiExportResult

ApiExportResult: object

API Export result.

Optional exportResultFormat

exportResultFormat: ExportResultFormat

Format in which the Api Details are exported to the Storage Blob with Sas Key valid for 5 minutes. Possible values include: 'Swagger', 'Wsdl', 'Wadl', 'OpenApi'

Optional id

id: undefined | string

ResourceId of the API which was exported.

Optional value

value: ApiExportResultValue

The object defining the schema of the exported Api Detail

serializedName

serializedName: string = "ApiExportResult"

type

type: object

className

className: string = "ApiExportResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

exportResultFormat

exportResultFormat: object

serializedName

serializedName: string = "format"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

className

className: string = "ApiExportResultValue"

name

name: "Composite" = "Composite"

Const ApiExportResultValue

ApiExportResultValue: object

The object defining the schema of the exported Api Detail

Optional link

link: undefined | string

Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes.

serializedName

serializedName: string = "ApiExportResult_value"

type

type: object

className

className: string = "ApiExportResultValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

link

link: object

serializedName

serializedName: string = "link"

type

type: object

name

name: "String" = "String"

Const ApiGetEntityTagHeaders

ApiGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "api-getentitytag-headers"

type

type: object

className

className: string = "ApiGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiGetHeaders

ApiGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "api-get-headers"

type

type: object

className

className: string = "ApiGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiIssueAttachmentCreateOrUpdateHeaders

ApiIssueAttachmentCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiissueattachment-createorupdate-headers"

type

type: object

className

className: string = "ApiIssueAttachmentCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiIssueAttachmentGetEntityTagHeaders

ApiIssueAttachmentGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiissueattachment-getentitytag-headers"

type

type: object

className

className: string = "ApiIssueAttachmentGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiIssueAttachmentGetHeaders

ApiIssueAttachmentGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiissueattachment-get-headers"

type

type: object

className

className: string = "ApiIssueAttachmentGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiIssueCommentCreateOrUpdateHeaders

ApiIssueCommentCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiissuecomment-createorupdate-headers"

type

type: object

className

className: string = "ApiIssueCommentCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiIssueCommentGetEntityTagHeaders

ApiIssueCommentGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiissuecomment-getentitytag-headers"

type

type: object

className

className: string = "ApiIssueCommentGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiIssueCommentGetHeaders

ApiIssueCommentGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiissuecomment-get-headers"

type

type: object

className

className: string = "ApiIssueCommentGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiIssueCreateOrUpdateHeaders

ApiIssueCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiissue-createorupdate-headers"

type

type: object

className

className: string = "ApiIssueCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiIssueGetEntityTagHeaders

ApiIssueGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiissue-getentitytag-headers"

type

type: object

className

className: string = "ApiIssueGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiIssueGetHeaders

ApiIssueGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiissue-get-headers"

type

type: object

className

className: string = "ApiIssueGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiManagementServiceApplyNetworkConfigurationParameters

ApiManagementServiceApplyNetworkConfigurationParameters: object

Parameter supplied to the Apply Network configuration operation.

Optional location

location: undefined | string

Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required.

serializedName

serializedName: string = "ApiManagementServiceApplyNetworkConfigurationParameters"

type

type: object

className

className: string = "ApiManagementServiceApplyNetworkConfigurationParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const ApiManagementServiceBackupRestoreParameters

ApiManagementServiceBackupRestoreParameters: object

Parameters supplied to the Backup/Restore of an API Management service operation.

accessKey

accessKey: string

Azure Cloud Storage account (used to place/retrieve the backup) access key.

backupName

backupName: string

The name of the backup file to create.

containerName

containerName: string

Azure Cloud Storage blob container name used to place/retrieve the backup.

storageAccount

storageAccount: string

Azure Cloud Storage account (used to place/retrieve the backup) name.

serializedName

serializedName: string = "ApiManagementServiceBackupRestoreParameters"

type

type: object

className

className: string = "ApiManagementServiceBackupRestoreParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessKey

accessKey: object

required

required: true = true

serializedName

serializedName: string = "accessKey"

type

type: object

name

name: "String" = "String"

backupName

backupName: object

required

required: true = true

serializedName

serializedName: string = "backupName"

type

type: object

name

name: "String" = "String"

containerName

containerName: object

required

required: true = true

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

storageAccount

storageAccount: object

required

required: true = true

serializedName

serializedName: string = "storageAccount"

type

type: object

name

name: "String" = "String"

Const ApiManagementServiceBaseProperties

ApiManagementServiceBaseProperties: object

Base Properties of an API Management service resource description.

Optional additionalLocations

additionalLocations: AdditionalLocation[]

Additional datacenter locations of the API Management service.

Optional certificates

certificates: CertificateConfiguration[]

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

Optional createdAtUtc

createdAtUtc: Date

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. NOTE: This property will not be serialized. It can only be populated by the server.

Optional customProperties

customProperties: undefined | object

Custom properties of the API Management service. Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1 and setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.

Optional enableClientCertificate

enableClientCertificate: undefined | false | true

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway. Default value: false.

Optional gatewayRegionalUrl

gatewayRegionalUrl: undefined | string

Gateway URL of the API Management service in the Default Region. NOTE: This property will not be serialized. It can only be populated by the server.

Optional gatewayUrl

gatewayUrl: undefined | string

Gateway URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostnameConfigurations

hostnameConfigurations: HostnameConfiguration[]

Custom hostname configuration of the API Management service.

Optional managementApiUrl

managementApiUrl: undefined | string

Management API endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notificationSenderEmail

notificationSenderEmail: undefined | string

Email address from which the notification will be sent.

Optional portalUrl

portalUrl: undefined | string

Publisher portal endpoint Url of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateIPAddresses

privateIPAddresses: string[]

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicIPAddresses

publicIPAddresses: string[]

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scmUrl

scmUrl: undefined | string

SCM endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional targetProvisioningState

targetProvisioningState: undefined | string

The provisioning state of the API Management service, which is targeted by the long running operation started on the service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional virtualNetworkConfiguration

virtualNetworkConfiguration: VirtualNetworkConfiguration

Virtual network configuration of the API Management service.

Optional virtualNetworkType

virtualNetworkType: VirtualNetworkType

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: 'None', 'External', 'Internal'. Default value: 'None'.

serializedName

serializedName: string = "ApiManagementServiceBaseProperties"

type

type: object

className

className: string = "ApiManagementServiceBaseProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

additionalLocations

additionalLocations: object

serializedName

serializedName: string = "additionalLocations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AdditionalLocation"

name

name: "Composite" = "Composite"

certificates

certificates: object

serializedName

serializedName: string = "certificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateConfiguration"

name

name: "Composite" = "Composite"

createdAtUtc

createdAtUtc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "createdAtUtc"

type

type: object

name

name: "DateTime" = "DateTime"

customProperties

customProperties: object

serializedName

serializedName: string = "customProperties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

enableClientCertificate

enableClientCertificate: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "enableClientCertificate"

type

type: object

name

name: "Boolean" = "Boolean"

gatewayRegionalUrl

gatewayRegionalUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "gatewayRegionalUrl"

type

type: object

name

name: "String" = "String"

gatewayUrl

gatewayUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "gatewayUrl"

type

type: object

name

name: "String" = "String"

hostnameConfigurations

hostnameConfigurations: object

serializedName

serializedName: string = "hostnameConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HostnameConfiguration"

name

name: "Composite" = "Composite"

managementApiUrl

managementApiUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "managementApiUrl"

type

type: object

name

name: "String" = "String"

notificationSenderEmail

notificationSenderEmail: object

serializedName

serializedName: string = "notificationSenderEmail"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

portalUrl

portalUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "portalUrl"

type

type: object

name

name: "String" = "String"

privateIPAddresses

privateIPAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "privateIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddresses

publicIPAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "publicIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

scmUrl

scmUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "scmUrl"

type

type: object

name

name: "String" = "String"

targetProvisioningState

targetProvisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "targetProvisioningState"

type

type: object

name

name: "String" = "String"

virtualNetworkConfiguration

virtualNetworkConfiguration: object

serializedName

serializedName: string = "virtualNetworkConfiguration"

type

type: object

className

className: string = "VirtualNetworkConfiguration"

name

name: "Composite" = "Composite"

virtualNetworkType

virtualNetworkType: object

defaultValue

defaultValue: string = "None"

serializedName

serializedName: string = "virtualNetworkType"

type

type: object

name

name: "String" = "String"

Const ApiManagementServiceCheckNameAvailabilityParameters

ApiManagementServiceCheckNameAvailabilityParameters: object

Parameters supplied to the CheckNameAvailability operation.

name

name: string

The name to check for availability.

serializedName

serializedName: string = "ApiManagementServiceCheckNameAvailabilityParameters"

type

type: object

className

className: string = "ApiManagementServiceCheckNameAvailabilityParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ApiManagementServiceGetSsoTokenResult

ApiManagementServiceGetSsoTokenResult: object

The response of the GetSsoToken operation.

Optional redirectUri

redirectUri: undefined | string

Redirect URL to the Publisher Portal containing the SSO token.

serializedName

serializedName: string = "ApiManagementServiceGetSsoTokenResult"

type

type: object

className

className: string = "ApiManagementServiceGetSsoTokenResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

redirectUri

redirectUri: object

serializedName

serializedName: string = "redirectUri"

type

type: object

name

name: "String" = "String"

Const ApiManagementServiceIdentity

ApiManagementServiceIdentity: object

Identity properties of the Api Management service resource.

Optional principalId

principalId: undefined | string

The principal id of the identity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string

The client tenant id of the identity. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApiManagementServiceIdentity"

type

type: object

className

className: string = "ApiManagementServiceIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "Uuid" = "Uuid"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "Uuid" = "Uuid"

type

type: object

defaultValue

defaultValue: string = "SystemAssigned"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ApiManagementServiceListResult

ApiManagementServiceListResult: object
interface

The response of the List API Management services operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to the next set of results. Not empty if Value contains incomplete list of API Management services.

serializedName

serializedName: string = "ApiManagementServiceListResult"

__@iterator

  • Iterator

    Returns IterableIterator<ApiManagementServiceResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns ApiManagementServiceResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApiManagementServiceResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApiManagementServiceResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApiManagementServiceResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns ApiManagementServiceResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApiManagementServiceResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApiManagementServiceResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApiManagementServiceResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApiManagementServiceResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ApiManagementServiceResource | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns ApiManagementServiceResource[]

shift

  • Removes the first element from an array and returns it.

    Returns ApiManagementServiceResource | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApiManagementServiceResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApiManagementServiceResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApiManagementServiceResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApiManagementServiceResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ApiManagementServiceResource>

type

type: object

className

className: string = "ApiManagementServiceListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApiManagementServiceResource"

name

name: "Composite" = "Composite"

Const ApiManagementServiceNameAvailabilityResult

ApiManagementServiceNameAvailabilityResult: object

Response of the CheckNameAvailability operation.

Optional message

message: undefined | string

If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nameAvailable

nameAvailable: undefined | false | true

True if the name is available and can be used to create a new API Management service; otherwise false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: NameAvailabilityReason

Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. Possible values include: 'Valid', 'Invalid', 'AlreadyExists'

serializedName

serializedName: string = "ApiManagementServiceNameAvailabilityResult"

type

type: object

className

className: string = "ApiManagementServiceNameAvailabilityResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

nameAvailable

nameAvailable: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nameAvailable"

type

type: object

name

name: "Boolean" = "Boolean"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

allowedValues

allowedValues: string[] = ["Valid","Invalid","AlreadyExists"]

name

name: "Enum" = "Enum"

Const ApiManagementServiceResource

ApiManagementServiceResource: object

A single API Management service resource in List or Get response.

Optional additionalLocations

additionalLocations: AdditionalLocation[]

Additional datacenter locations of the API Management service.

Optional certificates

certificates: CertificateConfiguration[]

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

Optional createdAtUtc

createdAtUtc: Date

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. NOTE: This property will not be serialized. It can only be populated by the server.

Optional customProperties

customProperties: undefined | object

Custom properties of the API Management service. Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1 and setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.

Optional enableClientCertificate

enableClientCertificate: undefined | false | true

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway. Default value: false.

Optional etag

etag: undefined | string

ETag of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional gatewayRegionalUrl

gatewayRegionalUrl: undefined | string

Gateway URL of the API Management service in the Default Region. NOTE: This property will not be serialized. It can only be populated by the server.

Optional gatewayUrl

gatewayUrl: undefined | string

Gateway URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostnameConfigurations

hostnameConfigurations: HostnameConfiguration[]

Custom hostname configuration of the API Management service.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

identity: ApiManagementServiceIdentity

Managed service identity of the Api Management service.

location

location: string

Resource location.

Optional managementApiUrl

managementApiUrl: undefined | string

Management API endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notificationSenderEmail

notificationSenderEmail: undefined | string

Email address from which the notification will be sent.

Optional portalUrl

portalUrl: undefined | string

Publisher portal endpoint Url of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateIPAddresses

privateIPAddresses: string[]

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicIPAddresses

publicIPAddresses: string[]

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. NOTE: This property will not be serialized. It can only be populated by the server.

publisherEmail

publisherEmail: string

Publisher email.

publisherName

publisherName: string

Publisher name.

Optional scmUrl

scmUrl: undefined | string

SCM endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

sku

sku: ApiManagementServiceSkuProperties

SKU properties of the API Management service.

Optional tags

tags: undefined | object

Resource tags.

Optional targetProvisioningState

targetProvisioningState: undefined | string

The provisioning state of the API Management service, which is targeted by the long running operation started on the service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional virtualNetworkConfiguration

virtualNetworkConfiguration: VirtualNetworkConfiguration

Virtual network configuration of the API Management service.

Optional virtualNetworkType

virtualNetworkType: VirtualNetworkType

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: 'None', 'External', 'Internal'. Default value: 'None'.

serializedName

serializedName: string = "ApiManagementServiceResource"

Optional type

type: object

Resource type for API Management resource is set to Microsoft.ApiManagement. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ApiManagementServiceResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

additionalLocations

additionalLocations: object

serializedName

serializedName: string = "properties.additionalLocations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AdditionalLocation"

name

name: "Composite" = "Composite"

certificates

certificates: object

serializedName

serializedName: string = "properties.certificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateConfiguration"

name

name: "Composite" = "Composite"

createdAtUtc

createdAtUtc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdAtUtc"

type

type: object

name

name: "DateTime" = "DateTime"

customProperties

customProperties: object

serializedName

serializedName: string = "properties.customProperties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

enableClientCertificate

enableClientCertificate: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.enableClientCertificate"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

gatewayRegionalUrl

gatewayRegionalUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.gatewayRegionalUrl"

type

type: object

name

name: "String" = "String"

gatewayUrl

gatewayUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.gatewayUrl"

type

type: object

name

name: "String" = "String"

hostnameConfigurations

hostnameConfigurations: object

serializedName

serializedName: string = "properties.hostnameConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HostnameConfiguration"

name

name: "Composite" = "Composite"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "ApiManagementServiceIdentity"

name

name: "Composite" = "Composite"

location

location: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

managementApiUrl

managementApiUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.managementApiUrl"

type

type: object

name

name: "String" = "String"

notificationSenderEmail

notificationSenderEmail: object

serializedName

serializedName: string = "properties.notificationSenderEmail"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

portalUrl

portalUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.portalUrl"

type

type: object

name

name: "String" = "String"

privateIPAddresses

privateIPAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.privateIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddresses

publicIPAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.publicIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

publisherEmail

publisherEmail: object

required

required: true = true

serializedName

serializedName: string = "properties.publisherEmail"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

publisherName

publisherName: object

required

required: true = true

serializedName

serializedName: string = "properties.publisherName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

scmUrl

scmUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.scmUrl"

type

type: object

name

name: "String" = "String"

sku

sku: object

required

required: true = true

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "ApiManagementServiceSkuProperties"

name

name: "Composite" = "Composite"

targetProvisioningState

targetProvisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.targetProvisioningState"

type

type: object

name

name: "String" = "String"

virtualNetworkConfiguration

virtualNetworkConfiguration: object

serializedName

serializedName: string = "properties.virtualNetworkConfiguration"

type

type: object

className

className: string = "VirtualNetworkConfiguration"

name

name: "Composite" = "Composite"

virtualNetworkType

virtualNetworkType: object

defaultValue

defaultValue: string = "None"

serializedName

serializedName: string = "properties.virtualNetworkType"

type

type: object

name

name: "String" = "String"

Const ApiManagementServiceSkuProperties

ApiManagementServiceSkuProperties: object

API Management service resource SKU properties.

Optional capacity

capacity: undefined | number

Capacity of the SKU (number of deployed units of the SKU).

name

name: SkuType

Name of the Sku. Possible values include: 'Developer', 'Standard', 'Premium', 'Basic', 'Consumption'

serializedName

serializedName: string = "ApiManagementServiceSkuProperties"

type

type: object

className

className: string = "ApiManagementServiceSkuProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

serializedName: string = "capacity"

type

type: object

name

name: "Number" = "Number"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ApiManagementServiceUpdateParameters

ApiManagementServiceUpdateParameters: object

Parameter supplied to Update Api Management Service.

Optional additionalLocations

additionalLocations: AdditionalLocation[]

Additional datacenter locations of the API Management service.

Optional certificates

certificates: CertificateConfiguration[]

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

Optional createdAtUtc

createdAtUtc: Date

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. NOTE: This property will not be serialized. It can only be populated by the server.

Optional customProperties

customProperties: undefined | object

Custom properties of the API Management service. Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1 and setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.

Optional enableClientCertificate

enableClientCertificate: undefined | false | true

Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway. Default value: false.

Optional etag

etag: undefined | string

ETag of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional gatewayRegionalUrl

gatewayRegionalUrl: undefined | string

Gateway URL of the API Management service in the Default Region. NOTE: This property will not be serialized. It can only be populated by the server.

Optional gatewayUrl

gatewayUrl: undefined | string

Gateway URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostnameConfigurations

hostnameConfigurations: HostnameConfiguration[]

Custom hostname configuration of the API Management service.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

identity: ApiManagementServiceIdentity

Managed service identity of the Api Management service.

Optional managementApiUrl

managementApiUrl: undefined | string

Management API endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notificationSenderEmail

notificationSenderEmail: undefined | string

Email address from which the notification will be sent.

Optional portalUrl

portalUrl: undefined | string

Publisher portal endpoint Url of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateIPAddresses

privateIPAddresses: string[]

Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicIPAddresses

publicIPAddresses: string[]

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publisherEmail

publisherEmail: undefined | string

Publisher email.

Optional publisherName

publisherName: undefined | string

Publisher name.

Optional scmUrl

scmUrl: undefined | string

SCM endpoint URL of the API Management service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sku

sku: ApiManagementServiceSkuProperties

SKU properties of the API Management service.

Optional tags

tags: undefined | object

Resource tags.

Optional targetProvisioningState

targetProvisioningState: undefined | string

The provisioning state of the API Management service, which is targeted by the long running operation started on the service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional virtualNetworkConfiguration

virtualNetworkConfiguration: VirtualNetworkConfiguration

Virtual network configuration of the API Management service.

Optional virtualNetworkType

virtualNetworkType: VirtualNetworkType

The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: 'None', 'External', 'Internal'. Default value: 'None'.

serializedName

serializedName: string = "ApiManagementServiceUpdateParameters"

Optional type

type: object

Resource type for API Management resource is set to Microsoft.ApiManagement. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ApiManagementServiceUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

additionalLocations

additionalLocations: object

serializedName

serializedName: string = "properties.additionalLocations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AdditionalLocation"

name

name: "Composite" = "Composite"

certificates

certificates: object

serializedName

serializedName: string = "properties.certificates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateConfiguration"

name

name: "Composite" = "Composite"

createdAtUtc

createdAtUtc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdAtUtc"

type

type: object

name

name: "DateTime" = "DateTime"

customProperties

customProperties: object

serializedName

serializedName: string = "properties.customProperties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

enableClientCertificate

enableClientCertificate: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.enableClientCertificate"

type

type: object

name

name: "Boolean" = "Boolean"

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

gatewayRegionalUrl

gatewayRegionalUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.gatewayRegionalUrl"

type

type: object

name

name: "String" = "String"

gatewayUrl

gatewayUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.gatewayUrl"

type

type: object

name

name: "String" = "String"

hostnameConfigurations

hostnameConfigurations: object

serializedName

serializedName: string = "properties.hostnameConfigurations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HostnameConfiguration"

name

name: "Composite" = "Composite"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "ApiManagementServiceIdentity"

name

name: "Composite" = "Composite"

managementApiUrl

managementApiUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.managementApiUrl"

type

type: object

name

name: "String" = "String"

notificationSenderEmail

notificationSenderEmail: object

serializedName

serializedName: string = "properties.notificationSenderEmail"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

portalUrl

portalUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.portalUrl"

type

type: object

name

name: "String" = "String"

privateIPAddresses

privateIPAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.privateIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publicIPAddresses

publicIPAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.publicIPAddresses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

publisherEmail

publisherEmail: object

serializedName

serializedName: string = "properties.publisherEmail"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

publisherName

publisherName: object

serializedName

serializedName: string = "properties.publisherName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

scmUrl

scmUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.scmUrl"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "ApiManagementServiceSkuProperties"

name

name: "Composite" = "Composite"

targetProvisioningState

targetProvisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.targetProvisioningState"

type

type: object

name

name: "String" = "String"

virtualNetworkConfiguration

virtualNetworkConfiguration: object

serializedName

serializedName: string = "properties.virtualNetworkConfiguration"

type

type: object

className

className: string = "VirtualNetworkConfiguration"

name

name: "Composite" = "Composite"

virtualNetworkType

virtualNetworkType: object

defaultValue

defaultValue: string = "None"

serializedName

serializedName: string = "properties.virtualNetworkType"

type

type: object

name

name: "String" = "String"

Const ApiOperationCreateOrUpdateHeaders

ApiOperationCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apioperation-createorupdate-headers"

type

type: object

className

className: string = "ApiOperationCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiOperationGetEntityTagHeaders

ApiOperationGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apioperation-getentitytag-headers"

type

type: object

className

className: string = "ApiOperationGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiOperationGetHeaders

ApiOperationGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apioperation-get-headers"

type

type: object

className

className: string = "ApiOperationGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiOperationPolicyCreateOrUpdateHeaders

ApiOperationPolicyCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apioperationpolicy-createorupdate-headers"

type

type: object

className

className: string = "ApiOperationPolicyCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiOperationPolicyGetEntityTagHeaders

ApiOperationPolicyGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apioperationpolicy-getentitytag-headers"

type

type: object

className

className: string = "ApiOperationPolicyGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiOperationPolicyGetHeaders

ApiOperationPolicyGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apioperationpolicy-get-headers"

type

type: object

className

className: string = "ApiOperationPolicyGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiPolicyCreateOrUpdateHeaders

ApiPolicyCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apipolicy-createorupdate-headers"

type

type: object

className

className: string = "ApiPolicyCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiPolicyGetEntityTagHeaders

ApiPolicyGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apipolicy-getentitytag-headers"

type

type: object

className

className: string = "ApiPolicyGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiPolicyGetHeaders

ApiPolicyGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apipolicy-get-headers"

type

type: object

className

className: string = "ApiPolicyGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiReleaseCollection

ApiReleaseCollection: object
interface

Paged ApiRelease list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApiReleaseCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ApiReleaseContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ApiReleaseContract>[]

      Additional items to add to the end of array1.

    Returns ApiReleaseContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApiReleaseContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApiReleaseContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ApiReleaseContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApiReleaseContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ApiReleaseContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ApiReleaseContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApiReleaseContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ApiReleaseContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApiReleaseContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApiReleaseContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApiReleaseContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ApiReleaseContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ApiReleaseContract

  • Parameters

    Returns ApiReleaseContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ApiReleaseContract

  • Parameters

    Returns ApiReleaseContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ApiReleaseContract[]

shift

  • Removes the first element from an array and returns it.

    Returns ApiReleaseContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApiReleaseContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApiReleaseContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApiReleaseContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApiReleaseContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ApiReleaseContract>

type

type: object

className

className: string = "ApiReleaseCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApiReleaseContract"

name

name: "Composite" = "Composite"

Const ApiReleaseContract

ApiReleaseContract: object

ApiRelease details.

Optional apiId

apiId: undefined | string

Identifier of the API the release belongs to.

Optional createdDateTime

createdDateTime: Date

The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notes

notes: undefined | string

Release Notes

Optional updatedDateTime

updatedDateTime: Date

The time the API release was updated. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApiReleaseContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ApiReleaseContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiId

apiId: object

serializedName

serializedName: string = "properties.apiId"

type

type: object

name

name: "String" = "String"

createdDateTime

createdDateTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

notes

notes: object

serializedName

serializedName: string = "properties.notes"

type

type: object

name

name: "String" = "String"

updatedDateTime

updatedDateTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.updatedDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const ApiReleaseCreateOrUpdateHeaders

ApiReleaseCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apirelease-createorupdate-headers"

type

type: object

className

className: string = "ApiReleaseCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiReleaseGetEntityTagHeaders

ApiReleaseGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apirelease-getentitytag-headers"

type

type: object

className

className: string = "ApiReleaseGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiReleaseGetHeaders

ApiReleaseGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apirelease-get-headers"

type

type: object

className

className: string = "ApiReleaseGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiRevisionCollection

ApiRevisionCollection: object
interface

Paged Api Revision list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApiRevisionCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ApiRevisionContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ApiRevisionContract>[]

      Additional items to add to the end of array1.

    Returns ApiRevisionContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApiRevisionContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApiRevisionContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApiRevisionContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ApiRevisionContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ApiRevisionContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApiRevisionContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ApiRevisionContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApiRevisionContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApiRevisionContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApiRevisionContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ApiRevisionContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ApiRevisionContract

  • Parameters

    Returns ApiRevisionContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ApiRevisionContract

  • Parameters

    Returns ApiRevisionContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ApiRevisionContract[]

shift

  • Removes the first element from an array and returns it.

    Returns ApiRevisionContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApiRevisionContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApiRevisionContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApiRevisionContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApiRevisionContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ApiRevisionContract>

type

type: object

className

className: string = "ApiRevisionCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApiRevisionContract"

name

name: "Composite" = "Composite"

Const ApiRevisionContract

ApiRevisionContract: object

Summary of revision metadata.

Optional apiId

apiId: undefined | string

Identifier of the API Revision. NOTE: This property will not be serialized. It can only be populated by the server.

Optional apiRevision

apiRevision: undefined | string

Revision number of API. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdDateTime

createdDateTime: Date

The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

Description of the API Revision. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isCurrent

isCurrent: undefined | false | true

Indicates if API revision is accessible via the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isOnline

isOnline: undefined | false | true

Indicates if API revision is the current api revision. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateUrl

privateUrl: undefined | string

Gateway URL for accessing the non-current API Revision. NOTE: This property will not be serialized. It can only be populated by the server.

Optional updatedDateTime

updatedDateTime: Date

The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApiRevisionContract"

type

type: object

className

className: string = "ApiRevisionContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiId

apiId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "apiId"

type

type: object

name

name: "String" = "String"

apiRevision

apiRevision: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "apiRevision"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

createdDateTime

createdDateTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "createdDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

isCurrent

isCurrent: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "isCurrent"

type

type: object

name

name: "Boolean" = "Boolean"

isOnline

isOnline: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "isOnline"

type

type: object

name

name: "Boolean" = "Boolean"

privateUrl

privateUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "privateUrl"

type

type: object

name

name: "String" = "String"

updatedDateTime

updatedDateTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "updatedDateTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const ApiRevisionInfoContract

ApiRevisionInfoContract: object

Object used to create an API Revision or Version based on an existing API Revision

Optional apiRevisionDescription

apiRevisionDescription: undefined | string

Description of new API Revision.

Optional apiVersionName

apiVersionName: undefined | string

Version identifier for the new API Version.

Optional apiVersionSet

apiVersionSet: ApiVersionSetContractDetails

Version set details

Optional sourceApiId

sourceApiId: undefined | string

Resource identifier of API to be used to create the revision from.

serializedName

serializedName: string = "ApiRevisionInfoContract"

type

type: object

className

className: string = "ApiRevisionInfoContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiRevisionDescription

apiRevisionDescription: object

serializedName

serializedName: string = "apiRevisionDescription"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

apiVersionName

apiVersionName: object

serializedName

serializedName: string = "apiVersionName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

apiVersionSet

apiVersionSet: object

serializedName

serializedName: string = "apiVersionSet"

type

type: object

className

className: string = "ApiVersionSetContractDetails"

name

name: "Composite" = "Composite"

sourceApiId

sourceApiId: object

serializedName

serializedName: string = "sourceApiId"

type

type: object

name

name: "String" = "String"

Const ApiSchemaCreateOrUpdateHeaders

ApiSchemaCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apischema-createorupdate-headers"

type

type: object

className

className: string = "ApiSchemaCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiSchemaGetEntityTagHeaders

ApiSchemaGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apischema-getentitytag-headers"

type

type: object

className

className: string = "ApiSchemaGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiSchemaGetHeaders

ApiSchemaGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apischema-get-headers"

type

type: object

className

className: string = "ApiSchemaGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiTagDescriptionCreateOrUpdateHeaders

ApiTagDescriptionCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apitagdescription-createorupdate-headers"

type

type: object

className

className: string = "ApiTagDescriptionCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiTagDescriptionGetEntityTagHeaders

ApiTagDescriptionGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apitagdescription-getentitytag-headers"

type

type: object

className

className: string = "ApiTagDescriptionGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiTagDescriptionGetHeaders

ApiTagDescriptionGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apitagdescription-get-headers"

type

type: object

className

className: string = "ApiTagDescriptionGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiTagResourceContractProperties

ApiTagResourceContractProperties: object

API contract properties for the Tag Resources.

Optional apiRevision

apiRevision: undefined | string

Describes the Revision of the Api. If no value is provided, default revision 1 is created

Optional apiRevisionDescription

apiRevisionDescription: undefined | string

Description of the Api Revision.

Optional apiType

apiType: ApiType

Type of API. Possible values include: 'http', 'soap'

Optional apiVersion

apiVersion: undefined | string

Indicates the Version identifier of the API if the API is versioned

Optional apiVersionDescription

apiVersionDescription: undefined | string

Description of the Api Version.

Optional apiVersionSetId

apiVersionSetId: undefined | string

A resource identifier for the related ApiVersionSet.

Optional authenticationSettings

authenticationSettings: AuthenticationSettingsContract

Collection of authentication settings included into this API.

Optional description

description: undefined | string

Description of the API. May include HTML formatting tags.

Optional id

id: undefined | string

API identifier in the form /apis/{apiId}.

Optional isCurrent

isCurrent: undefined | false | true

Indicates if API revision is current api revision.

Optional isOnline

isOnline: undefined | false | true

Indicates if API revision is accessible via the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

API name.

Optional path

path: undefined | string

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Optional protocols

protocols: Protocol[]

Describes on which protocols the operations in this API can be invoked.

Optional serviceUrl

serviceUrl: undefined | string

Absolute URL of the backend service implementing this API.

Optional subscriptionKeyParameterNames

subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContract

Protocols over which API is made available.

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Specifies whether an API or Product subscription is required for accessing the API.

serializedName

serializedName: string = "ApiTagResourceContractProperties"

type

type: object

className

className: string = "ApiTagResourceContractProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

path

path: object

serializedName

serializedName: string = "path"

constraints

constraints: object

MaxLength

MaxLength: number = 400

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

protocols

protocols: object

serializedName

serializedName: string = "protocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["http","https"]

name

name: "Enum" = "Enum"

serviceUrl

serviceUrl: object

serializedName

serializedName: string = "serviceUrl"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const ApiUpdateContract

ApiUpdateContract: object

API update contract details.

Optional apiRevision

apiRevision: undefined | string

Describes the Revision of the Api. If no value is provided, default revision 1 is created

Optional apiRevisionDescription

apiRevisionDescription: undefined | string

Description of the Api Revision.

Optional apiType

apiType: ApiType

Type of API. Possible values include: 'http', 'soap'

Optional apiVersion

apiVersion: undefined | string

Indicates the Version identifier of the API if the API is versioned

Optional apiVersionDescription

apiVersionDescription: undefined | string

Description of the Api Version.

Optional apiVersionSetId

apiVersionSetId: undefined | string

A resource identifier for the related ApiVersionSet.

Optional authenticationSettings

authenticationSettings: AuthenticationSettingsContract

Collection of authentication settings included into this API.

Optional description

description: undefined | string

Description of the API. May include HTML formatting tags.

Optional displayName

displayName: undefined | string

API name.

Optional isCurrent

isCurrent: undefined | false | true

Indicates if API revision is current api revision.

Optional isOnline

isOnline: undefined | false | true

Indicates if API revision is accessible via the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional path

path: undefined | string

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Optional protocols

protocols: Protocol[]

Describes on which protocols the operations in this API can be invoked.

Optional serviceUrl

serviceUrl: undefined | string

Absolute URL of the backend service implementing this API.

Optional subscriptionKeyParameterNames

subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContract

Protocols over which API is made available.

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Specifies whether an API or Product subscription is required for accessing the API.

serializedName

serializedName: string = "ApiUpdateContract"

type

type: object

className

className: string = "ApiUpdateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiRevision

apiRevision: object

serializedName

serializedName: string = "properties.apiRevision"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

apiRevisionDescription

apiRevisionDescription: object

serializedName

serializedName: string = "properties.apiRevisionDescription"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

apiType

apiType: object

serializedName

serializedName: string = "properties.type"

type

type: object

name

name: "String" = "String"

apiVersion

apiVersion: object

serializedName

serializedName: string = "properties.apiVersion"

constraints

constraints: object

MaxLength

MaxLength: number = 100

type

type: object

name

name: "String" = "String"

apiVersionDescription

apiVersionDescription: object

serializedName

serializedName: string = "properties.apiVersionDescription"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

apiVersionSetId

apiVersionSetId: object

serializedName

serializedName: string = "properties.apiVersionSetId"

type

type: object

name

name: "String" = "String"

authenticationSettings

authenticationSettings: object

serializedName

serializedName: string = "properties.authenticationSettings"

type

type: object

className

className: string = "AuthenticationSettingsContract"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

isCurrent

isCurrent: object

serializedName

serializedName: string = "properties.isCurrent"

type

type: object

name

name: "Boolean" = "Boolean"

isOnline

isOnline: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isOnline"

type

type: object

name

name: "Boolean" = "Boolean"

path

path: object

serializedName

serializedName: string = "properties.path"

constraints

constraints: object

MaxLength

MaxLength: number = 400

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

protocols

protocols: object

serializedName

serializedName: string = "properties.protocols"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["http","https"]

name

name: "Enum" = "Enum"

serviceUrl

serviceUrl: object

serializedName

serializedName: string = "properties.serviceUrl"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

subscriptionKeyParameterNames

subscriptionKeyParameterNames: object

serializedName

serializedName: string = "properties.subscriptionKeyParameterNames"

type

type: object

className

className: string = "SubscriptionKeyParameterNamesContract"

name

name: "Composite" = "Composite"

subscriptionRequired

subscriptionRequired: object

serializedName

serializedName: string = "properties.subscriptionRequired"

type

type: object

name

name: "Boolean" = "Boolean"

Const ApiVersionSetCollection

ApiVersionSetCollection: object
interface

Paged Api Version Set list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "ApiVersionSetCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ApiVersionSetContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns ApiVersionSetContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApiVersionSetContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApiVersionSetContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApiVersionSetContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ApiVersionSetContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ApiVersionSetContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApiVersionSetContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ApiVersionSetContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApiVersionSetContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApiVersionSetContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApiVersionSetContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ApiVersionSetContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ApiVersionSetContract

  • Parameters

    Returns ApiVersionSetContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ApiVersionSetContract[]

shift

  • Removes the first element from an array and returns it.

    Returns ApiVersionSetContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApiVersionSetContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApiVersionSetContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApiVersionSetContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApiVersionSetContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ApiVersionSetContract>

type

type: object

className

className: string = "ApiVersionSetCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApiVersionSetContract"

name

name: "Composite" = "Composite"

Const ApiVersionSetContract

ApiVersionSetContract: object

Api Version Set Contract details.

Optional description

description: undefined | string

Description of API Version Set.

displayName

displayName: string

Name of API Version Set

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional versionHeaderName

versionHeaderName: undefined | string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

Optional versionQueryName

versionQueryName: undefined | string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

versioningScheme

versioningScheme: VersioningScheme

An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'Segment', 'Query', 'Header'

serializedName

serializedName: string = "ApiVersionSetContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ApiVersionSetContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

versionHeaderName

versionHeaderName: object

serializedName

serializedName: string = "properties.versionHeaderName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

versionQueryName

versionQueryName: object

serializedName

serializedName: string = "properties.versionQueryName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

versioningScheme

versioningScheme: object

required

required: true = true

serializedName

serializedName: string = "properties.versioningScheme"

type

type: object

name

name: "String" = "String"

Const ApiVersionSetContractDetails

ApiVersionSetContractDetails: object

An API Version Set contains the common configuration for a set of API Versions relating

Optional description

description: undefined | string

Description of API Version Set.

Optional id

id: undefined | string

Identifier for existing API Version Set. Omit this value to create a new Version Set.

Optional name

name: undefined | string

The display Name of the API Version Set.

Optional versionHeaderName

versionHeaderName: undefined | string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

Optional versionQueryName

versionQueryName: undefined | string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

Optional versioningScheme

versioningScheme: VersioningScheme1

An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'Segment', 'Query', 'Header'

serializedName

serializedName: string = "ApiVersionSetContractDetails"

type

type: object

className

className: string = "ApiVersionSetContractDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

versionHeaderName

versionHeaderName: object

serializedName

serializedName: string = "versionHeaderName"

type

type: object

name

name: "String" = "String"

versionQueryName

versionQueryName: object

serializedName

serializedName: string = "versionQueryName"

type

type: object

name

name: "String" = "String"

versioningScheme

versioningScheme: object

serializedName

serializedName: string = "versioningScheme"

type

type: object

name

name: "String" = "String"

Const ApiVersionSetCreateOrUpdateHeaders

ApiVersionSetCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiversionset-createorupdate-headers"

type

type: object

className

className: string = "ApiVersionSetCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiVersionSetEntityBase

ApiVersionSetEntityBase: object

Api Version set base parameters

Optional description

description: undefined | string

Description of API Version Set.

Optional versionHeaderName

versionHeaderName: undefined | string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

Optional versionQueryName

versionQueryName: undefined | string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

serializedName

serializedName: string = "ApiVersionSetEntityBase"

type

type: object

className

className: string = "ApiVersionSetEntityBase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

versionHeaderName

versionHeaderName: object

serializedName

serializedName: string = "versionHeaderName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

versionQueryName

versionQueryName: object

serializedName

serializedName: string = "versionQueryName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const ApiVersionSetGetEntityTagHeaders

ApiVersionSetGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiversionset-getentitytag-headers"

type

type: object

className

className: string = "ApiVersionSetGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiVersionSetGetHeaders

ApiVersionSetGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "apiversionset-get-headers"

type

type: object

className

className: string = "ApiVersionSetGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ApiVersionSetUpdateParameters

ApiVersionSetUpdateParameters: object

Parameters to update or create an Api Version Set Contract.

Optional description

description: undefined | string

Description of API Version Set.

Optional displayName

displayName: undefined | string

Name of API Version Set

Optional versionHeaderName

versionHeaderName: undefined | string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

Optional versionQueryName

versionQueryName: undefined | string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

Optional versioningScheme

versioningScheme: VersioningScheme

An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'Segment', 'Query', 'Header'

serializedName

serializedName: string = "ApiVersionSetUpdateParameters"

type

type: object

className

className: string = "ApiVersionSetUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

versionHeaderName

versionHeaderName: object

serializedName

serializedName: string = "properties.versionHeaderName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

versionQueryName

versionQueryName: object

serializedName

serializedName: string = "properties.versionQueryName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

versioningScheme

versioningScheme: object

serializedName

serializedName: string = "properties.versioningScheme"

type

type: object

name

name: "String" = "String"

Const ApimResource

ApimResource: object

The Resource definition.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

serializedName

serializedName: string = "ApimResource"

Optional type

type: object

Resource type for API Management resource is set to Microsoft.ApiManagement. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ApimResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const AuthenticationSettingsContract

AuthenticationSettingsContract: object

API Authentication Settings.

Optional oAuth2

oAuth2: OAuth2AuthenticationSettingsContract

OAuth2 Authentication settings

Optional openid

openid: OpenIdAuthenticationSettingsContract

OpenID Connect Authentication Settings

Optional subscriptionKeyRequired

subscriptionKeyRequired: undefined | false | true

Specifies whether subscription key is required during call to this API, true - API is included into closed products only, false - API is included into open products alone, null - there is a mix of products.

serializedName

serializedName: string = "AuthenticationSettingsContract"

type

type: object

className

className: string = "AuthenticationSettingsContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

oAuth2

oAuth2: object

serializedName

serializedName: string = "oAuth2"

type

type: object

className

className: string = "OAuth2AuthenticationSettingsContract"

name

name: "Composite" = "Composite"

openid

openid: object

serializedName

serializedName: string = "openid"

type

type: object

className

className: string = "OpenIdAuthenticationSettingsContract"

name

name: "Composite" = "Composite"

subscriptionKeyRequired

subscriptionKeyRequired: object

serializedName

serializedName: string = "subscriptionKeyRequired"

type

type: object

name

name: "Boolean" = "Boolean"

Const AuthorizationServerCollection

AuthorizationServerCollection: object
interface

Paged OAuth2 Authorization Servers list representation.

extends

Array

Array

Array: ArrayConstructor

Optional count

count: undefined | number

Total record count number across all pages.

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "AuthorizationServerCollection"

__@iterator

  • Iterator

    Returns IterableIterator<AuthorizationServerContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns AuthorizationServerContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AuthorizationServerContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AuthorizationServerContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AuthorizationServerContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns AuthorizationServerContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AuthorizationServerContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns AuthorizationServerContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AuthorizationServerContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AuthorizationServerContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AuthorizationServerContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns AuthorizationServerContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns AuthorizationServerContract[]

shift

  • Removes the first element from an array and returns it.

    Returns AuthorizationServerContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AuthorizationServerContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AuthorizationServerContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AuthorizationServerContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns AuthorizationServerContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<AuthorizationServerContract>

type

type: object

className

className: string = "AuthorizationServerCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AuthorizationServerContract"

name

name: "Composite" = "Composite"

Const AuthorizationServerContract

AuthorizationServerContract: object

External OAuth authorization server settings.

authorizationEndpoint

authorizationEndpoint: string

OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.

Optional authorizationMethods

authorizationMethods: AuthorizationMethod[]

HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.

Optional bearerTokenSendingMethods

bearerTokenSendingMethods: BearerTokenSendingMethod[]

Specifies the mechanism by which access token is passed to the API.

Optional clientAuthenticationMethod

clientAuthenticationMethod: ClientAuthenticationMethod[]

Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.

clientId

clientId: string

Client or app id registered with this authorization server.

clientRegistrationEndpoint

clientRegistrationEndpoint: string

Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.

Optional clientSecret

clientSecret: undefined | string

Client or app secret registered with this authorization server.

Optional defaultScope

defaultScope: undefined | string

Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.

Optional description

description: undefined | string

Description of the authorization server. Can contain HTML formatting tags.

displayName

displayName: string

User-friendly authorization server name.

grantTypes

grantTypes: GrantType[]

Form of an authorization grant, which the client uses to request the access token.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceOwnerPassword

resourceOwnerPassword: undefined | string

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

Optional resourceOwnerUsername

resourceOwnerUsername: undefined | string

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

Optional supportState

supportState: undefined | false | true

If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.

Optional tokenBodyParameters

tokenBodyParameters: TokenBodyParameterContract[]

Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.

Optional tokenEndpoint

tokenEndpoint: undefined | string

OAuth token endpoint. Contains absolute URI to entity being referenced.

serializedName

serializedName: string = "AuthorizationServerContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "AuthorizationServerContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationEndpoint

authorizationEndpoint: object

required

required: true = true

serializedName

serializedName: string = "properties.authorizationEndpoint"

type

type: object

name

name: "String" = "String"

authorizationMethods

authorizationMethods: object

serializedName

serializedName: string = "properties.authorizationMethods"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["HEAD","OPTIONS","TRACE","GET","POST","PUT","PATCH","DELETE"]

name

name: "Enum" = "Enum"

bearerTokenSendingMethods

bearerTokenSendingMethods: object

serializedName

serializedName: string = "properties.bearerTokenSendingMethods"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

clientAuthenticationMethod

clientAuthenticationMethod: object

serializedName

serializedName: string = "properties.clientAuthenticationMethod"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "properties.clientId"

type

type: object

name

name: "String" = "String"

clientRegistrationEndpoint

clientRegistrationEndpoint: object

required

required: true = true

serializedName

serializedName: string = "properties.clientRegistrationEndpoint"

type

type: object

name

name: "String" = "String"

clientSecret

clientSecret: object

serializedName

serializedName: string = "properties.clientSecret"

type

type: object

name

name: "String" = "String"

defaultScope

defaultScope: object

serializedName

serializedName: string = "properties.defaultScope"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 50

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

grantTypes

grantTypes: object

required

required: true = true

serializedName

serializedName: string = "properties.grantTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

resourceOwnerPassword

resourceOwnerPassword: object

serializedName

serializedName: string = "properties.resourceOwnerPassword"

type

type: object

name

name: "String" = "String"

resourceOwnerUsername

resourceOwnerUsername: object

serializedName

serializedName: string = "properties.resourceOwnerUsername"

type

type: object

name

name: "String" = "String"

supportState

supportState: object

serializedName

serializedName: string = "properties.supportState"

type

type: object

name

name: "Boolean" = "Boolean"

tokenBodyParameters

tokenBodyParameters: object

serializedName

serializedName: string = "properties.tokenBodyParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TokenBodyParameterContract"

name

name: "Composite" = "Composite"

tokenEndpoint

tokenEndpoint: object

serializedName

serializedName: string = "properties.tokenEndpoint"

type

type: object

name

name: "String" = "String"

Const AuthorizationServerContractBaseProperties

AuthorizationServerContractBaseProperties: object

External OAuth authorization server Update settings contract.

Optional authorizationMethods

authorizationMethods: AuthorizationMethod[]

HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.

Optional bearerTokenSendingMethods

bearerTokenSendingMethods: BearerTokenSendingMethod[]

Specifies the mechanism by which access token is passed to the API.

Optional clientAuthenticationMethod

clientAuthenticationMethod: ClientAuthenticationMethod[]

Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.

Optional clientSecret

clientSecret: undefined | string

Client or app secret registered with this authorization server.

Optional defaultScope

defaultScope: undefined | string

Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.

Optional description

description: undefined | string

Description of the authorization server. Can contain HTML formatting tags.

Optional resourceOwnerPassword

resourceOwnerPassword: undefined | string

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

Optional resourceOwnerUsername

resourceOwnerUsername: undefined | string

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

Optional supportState

supportState: undefined | false | true

If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.

Optional tokenBodyParameters

tokenBodyParameters: TokenBodyParameterContract[]

Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.

Optional tokenEndpoint

tokenEndpoint: undefined | string

OAuth token endpoint. Contains absolute URI to entity being referenced.

serializedName

serializedName: string = "AuthorizationServerContractBaseProperties"

type

type: object

className

className: string = "AuthorizationServerContractBaseProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationMethods

authorizationMethods: object

serializedName

serializedName: string = "authorizationMethods"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["HEAD","OPTIONS","TRACE","GET","POST","PUT","PATCH","DELETE"]

name

name: "Enum" = "Enum"

bearerTokenSendingMethods

bearerTokenSendingMethods: object

serializedName

serializedName: string = "bearerTokenSendingMethods"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

clientAuthenticationMethod

clientAuthenticationMethod: object

serializedName

serializedName: string = "clientAuthenticationMethod"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

clientSecret

clientSecret: object

serializedName

serializedName: string = "clientSecret"

type

type: object

name

name: "String" = "String"

defaultScope

defaultScope: object

serializedName

serializedName: string = "defaultScope"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

resourceOwnerPassword

resourceOwnerPassword: object

serializedName

serializedName: string = "resourceOwnerPassword"

type

type: object

name

name: "String" = "String"

resourceOwnerUsername

resourceOwnerUsername: object

serializedName

serializedName: string = "resourceOwnerUsername"

type

type: object

name

name: "String" = "String"

supportState

supportState: object

serializedName

serializedName: string = "supportState"

type

type: object

name

name: "Boolean" = "Boolean"

tokenBodyParameters

tokenBodyParameters: object

serializedName

serializedName: string = "tokenBodyParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TokenBodyParameterContract"

name

name: "Composite" = "Composite"

tokenEndpoint

tokenEndpoint: object

serializedName

serializedName: string = "tokenEndpoint"

type

type: object

name

name: "String" = "String"

Const AuthorizationServerCreateOrUpdateHeaders

AuthorizationServerCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "authorizationserver-createorupdate-headers"

type

type: object

className

className: string = "AuthorizationServerCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const AuthorizationServerGetEntityTagHeaders

AuthorizationServerGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "authorizationserver-getentitytag-headers"

type

type: object

className

className: string = "AuthorizationServerGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const AuthorizationServerGetHeaders

AuthorizationServerGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "authorizationserver-get-headers"

type

type: object

className

className: string = "AuthorizationServerGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const AuthorizationServerUpdateContract

AuthorizationServerUpdateContract: object

External OAuth authorization server settings.

Optional authorizationEndpoint

authorizationEndpoint: undefined | string

OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.

Optional authorizationMethods

authorizationMethods: AuthorizationMethod[]

HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.

Optional bearerTokenSendingMethods

bearerTokenSendingMethods: BearerTokenSendingMethod[]

Specifies the mechanism by which access token is passed to the API.

Optional clientAuthenticationMethod

clientAuthenticationMethod: ClientAuthenticationMethod[]

Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.

Optional clientId

clientId: undefined | string

Client or app id registered with this authorization server.

Optional clientRegistrationEndpoint

clientRegistrationEndpoint: undefined | string

Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.

Optional clientSecret

clientSecret: undefined | string

Client or app secret registered with this authorization server.

Optional defaultScope

defaultScope: undefined | string

Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.

Optional description

description: undefined | string

Description of the authorization server. Can contain HTML formatting tags.

Optional displayName

displayName: undefined | string

User-friendly authorization server name.

Optional grantTypes

grantTypes: GrantType[]

Form of an authorization grant, which the client uses to request the access token.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceOwnerPassword

resourceOwnerPassword: undefined | string

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

Optional resourceOwnerUsername

resourceOwnerUsername: undefined | string

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

Optional supportState

supportState: undefined | false | true

If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.

Optional tokenBodyParameters

tokenBodyParameters: TokenBodyParameterContract[]

Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.

Optional tokenEndpoint

tokenEndpoint: undefined | string

OAuth token endpoint. Contains absolute URI to entity being referenced.

serializedName

serializedName: string = "AuthorizationServerUpdateContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "AuthorizationServerUpdateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationEndpoint

authorizationEndpoint: object

serializedName

serializedName: string = "properties.authorizationEndpoint"

type

type: object

name

name: "String" = "String"

authorizationMethods

authorizationMethods: object

serializedName

serializedName: string = "properties.authorizationMethods"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["HEAD","OPTIONS","TRACE","GET","POST","PUT","PATCH","DELETE"]

name

name: "Enum" = "Enum"

bearerTokenSendingMethods

bearerTokenSendingMethods: object

serializedName

serializedName: string = "properties.bearerTokenSendingMethods"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

clientAuthenticationMethod

clientAuthenticationMethod: object

serializedName

serializedName: string = "properties.clientAuthenticationMethod"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

clientId

clientId: object

serializedName

serializedName: string = "properties.clientId"

type

type: object

name

name: "String" = "String"

clientRegistrationEndpoint

clientRegistrationEndpoint: object

serializedName

serializedName: string = "properties.clientRegistrationEndpoint"

type

type: object

name

name: "String" = "String"

clientSecret

clientSecret: object

serializedName

serializedName: string = "properties.clientSecret"

type

type: object

name

name: "String" = "String"

defaultScope

defaultScope: object

serializedName

serializedName: string = "properties.defaultScope"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 50

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

grantTypes

grantTypes: object

serializedName

serializedName: string = "properties.grantTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

resourceOwnerPassword

resourceOwnerPassword: object

serializedName

serializedName: string = "properties.resourceOwnerPassword"

type

type: object

name

name: "String" = "String"

resourceOwnerUsername

resourceOwnerUsername: object

serializedName

serializedName: string = "properties.resourceOwnerUsername"

type

type: object

name

name: "String" = "String"

supportState

supportState: object

serializedName

serializedName: string = "properties.supportState"

type

type: object

name

name: "Boolean" = "Boolean"

tokenBodyParameters

tokenBodyParameters: object

serializedName

serializedName: string = "properties.tokenBodyParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TokenBodyParameterContract"

name

name: "Composite" = "Composite"

tokenEndpoint

tokenEndpoint: object

serializedName

serializedName: string = "properties.tokenEndpoint"

type

type: object

name

name: "String" = "String"

Const BackendAuthorizationHeaderCredentials

BackendAuthorizationHeaderCredentials: object

Authorization header information.

parameter

parameter: string

Authentication Parameter value.

scheme

scheme: string

Authentication Scheme name.

serializedName

serializedName: string = "BackendAuthorizationHeaderCredentials"

type

type: object

className

className: string = "BackendAuthorizationHeaderCredentials"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameter

parameter: object

required

required: true = true

serializedName

serializedName: string = "parameter"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

scheme

scheme: object

required

required: true = true

serializedName

serializedName: string = "scheme"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const BackendBaseParameters

BackendBaseParameters: object

Backend entity base Parameter set.

Optional credentials

credentials: BackendCredentialsContract

Backend Credentials Contract Properties

Optional description

description: undefined | string

Backend Description.

Optional properties

properties: BackendProperties

Backend Properties contract

Optional proxy

proxy: BackendProxyContract

Backend Proxy Contract Properties

Optional resourceId

resourceId: undefined | string

Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.

Optional title

title: undefined | string

Backend Title.

Optional tls

tls: BackendTlsProperties

Backend TLS Properties

serializedName

serializedName: string = "BackendBaseParameters"

type

type: object

className

className: string = "BackendBaseParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

credentials

credentials: object

serializedName

serializedName: string = "credentials"

type

type: object

className

className: string = "BackendCredentialsContract"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "BackendProperties"

name

name: "Composite" = "Composite"

proxy

proxy: object

serializedName

serializedName: string = "proxy"

type

type: object

className

className: string = "BackendProxyContract"

name

name: "Composite" = "Composite"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "title"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

tls

tls: object

serializedName

serializedName: string = "tls"

type

type: object

className

className: string = "BackendTlsProperties"

name

name: "Composite" = "Composite"

Const BackendCollection

BackendCollection: object
interface

Paged Backend list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "BackendCollection"

__@iterator

  • Iterator

    Returns IterableIterator<BackendContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BackendContract>[]

      Additional items to add to the end of array1.

    Returns BackendContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BackendContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BackendContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BackendContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BackendContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BackendContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BackendContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BackendContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns BackendContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BackendContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BackendContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BackendContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BackendContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BackendContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BackendContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns BackendContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns BackendContract

  • Parameters

    Returns BackendContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns BackendContract

  • Parameters

    Returns BackendContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns BackendContract[]

shift

  • Removes the first element from an array and returns it.

    Returns BackendContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BackendContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BackendContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BackendContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BackendContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns BackendContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BackendContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<BackendContract>

type

type: object

className

className: string = "BackendCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackendContract"

name

name: "Composite" = "Composite"

Const BackendContract

BackendContract: object

Backend details.

Optional credentials

credentials: BackendCredentialsContract

Backend Credentials Contract Properties

Optional description

description: undefined | string

Backend Description.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: BackendProperties

Backend Properties contract

protocol

protocol: BackendProtocol

Backend communication protocol. Possible values include: 'http', 'soap'

Optional proxy

proxy: BackendProxyContract

Backend Proxy Contract Properties

Optional resourceId

resourceId: undefined | string

Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.

Optional title

title: undefined | string

Backend Title.

Optional tls

tls: BackendTlsProperties

Backend TLS Properties

url

url: string

Runtime Url of the Backend.

serializedName

serializedName: string = "BackendContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "BackendContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

credentials

credentials: object

serializedName

serializedName: string = "properties.credentials"

type

type: object

className

className: string = "BackendCredentialsContract"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties.properties"

type

type: object

className

className: string = "BackendProperties"

name

name: "Composite" = "Composite"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

proxy

proxy: object

serializedName

serializedName: string = "properties.proxy"

type

type: object

className

className: string = "BackendProxyContract"

name

name: "Composite" = "Composite"

resourceId

resourceId: object

serializedName

serializedName: string = "properties.resourceId"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "properties.title"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

tls

tls: object

serializedName

serializedName: string = "properties.tls"

type

type: object

className

className: string = "BackendTlsProperties"

name

name: "Composite" = "Composite"

url

url: object

required

required: true = true

serializedName

serializedName: string = "properties.url"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const BackendCreateOrUpdateHeaders

BackendCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "backend-createorupdate-headers"

type

type: object

className

className: string = "BackendCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const BackendCredentialsContract

BackendCredentialsContract: object

Details of the Credentials used to connect to Backend.

Optional authorization

authorization: BackendAuthorizationHeaderCredentials

Authorization header authentication

Optional certificate

certificate: string[]

List of Client Certificate Thumbprint.

Optional header

header: undefined | object

Header Parameter description.

Optional query

query: undefined | object

Query Parameter description.

serializedName

serializedName: string = "BackendCredentialsContract"

type

type: object

className

className: string = "BackendCredentialsContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorization

authorization: object

serializedName

serializedName: string = "authorization"

type

type: object

className

className: string = "BackendAuthorizationHeaderCredentials"

name

name: "Composite" = "Composite"

certificate

certificate: object

serializedName

serializedName: string = "certificate"

constraints

constraints: object

MaxItems

MaxItems: number = 32

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

header

header: object

serializedName

serializedName: string = "header"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const BackendGetEntityTagHeaders

BackendGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "backend-getentitytag-headers"

type

type: object

className

className: string = "BackendGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const BackendGetHeaders

BackendGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "backend-get-headers"

type

type: object

className

className: string = "BackendGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const BackendProperties

BackendProperties: object

Properties specific to the Backend Type.

Optional serviceFabricCluster

serviceFabricCluster: BackendServiceFabricClusterProperties

Backend Service Fabric Cluster Properties

serializedName

serializedName: string = "BackendProperties"

type

type: object

className

className: string = "BackendProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

serviceFabricCluster

serviceFabricCluster: object

serializedName

serializedName: string = "serviceFabricCluster"

type

type: object

className

className: string = "BackendServiceFabricClusterProperties"

name

name: "Composite" = "Composite"

Const BackendProxyContract

BackendProxyContract: object

Details of the Backend WebProxy Server to use in the Request to Backend.

Optional password

password: undefined | string

Password to connect to the WebProxy Server

url

url: string

WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.

Optional username

username: undefined | string

Username to connect to the WebProxy server

serializedName

serializedName: string = "BackendProxyContract"

type

type: object

className

className: string = "BackendProxyContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

password

password: object

serializedName

serializedName: string = "password"

type

type: object

name

name: "String" = "String"

url

url: object

required

required: true = true

serializedName

serializedName: string = "url"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

username

username: object

serializedName

serializedName: string = "username"

type

type: object

name

name: "String" = "String"

Const BackendReconnectContract

BackendReconnectContract: object

Reconnect request parameters.

Optional after

after: undefined | string

Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackendReconnectContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "BackendReconnectContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

after

after: object

serializedName

serializedName: string = "properties.after"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties: object

Properties of the Service Fabric Type Backend.

clientCertificatethumbprint

clientCertificatethumbprint: string

The client certificate thumbprint for the management endpoint.

managementEndpoints

managementEndpoints: string[]

The cluster management endpoint.

Optional maxPartitionResolutionRetries

maxPartitionResolutionRetries: undefined | number

Maximum number of retries while attempting resolve the partition.

Optional serverCertificateThumbprints

serverCertificateThumbprints: string[]

Thumbprints of certificates cluster management service uses for tls communication

Optional serverX509Names

serverX509Names: X509CertificateName[]

Server X509 Certificate Names Collection

serializedName

serializedName: string = "BackendServiceFabricClusterProperties"

type

type: object

className

className: string = "BackendServiceFabricClusterProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientCertificatethumbprint

clientCertificatethumbprint: object

required

required: true = true

serializedName

serializedName: string = "clientCertificatethumbprint"

type

type: object

name

name: "String" = "String"

managementEndpoints

managementEndpoints: object

required

required: true = true

serializedName

serializedName: string = "managementEndpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

maxPartitionResolutionRetries

maxPartitionResolutionRetries: object

serializedName

serializedName: string = "maxPartitionResolutionRetries"

type

type: object

name

name: "Number" = "Number"

serverCertificateThumbprints

serverCertificateThumbprints: object

serializedName

serializedName: string = "serverCertificateThumbprints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

serverX509Names

serverX509Names: object

serializedName

serializedName: string = "serverX509Names"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "X509CertificateName"

name

name: "Composite" = "Composite"

Const BackendTlsProperties

BackendTlsProperties: object

Properties controlling TLS Certificate Validation.

Optional validateCertificateChain

validateCertificateChain: undefined | false | true

Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. Default value: true.

Optional validateCertificateName

validateCertificateName: undefined | false | true

Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. Default value: true.

serializedName

serializedName: string = "BackendTlsProperties"

type

type: object

className

className: string = "BackendTlsProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

validateCertificateChain

validateCertificateChain: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "validateCertificateChain"

type

type: object

name

name: "Boolean" = "Boolean"

validateCertificateName

validateCertificateName: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "validateCertificateName"

type

type: object

name

name: "Boolean" = "Boolean"

Const BackendUpdateParameters

BackendUpdateParameters: object

Backend update parameters.

Optional credentials

credentials: BackendCredentialsContract

Backend Credentials Contract Properties

Optional description

description: undefined | string

Backend Description.

Optional properties

properties: BackendProperties

Backend Properties contract

Optional protocol

protocol: BackendProtocol

Backend communication protocol. Possible values include: 'http', 'soap'

Optional proxy

proxy: BackendProxyContract

Backend Proxy Contract Properties

Optional resourceId

resourceId: undefined | string

Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.

Optional title

title: undefined | string

Backend Title.

Optional tls

tls: BackendTlsProperties

Backend TLS Properties

Optional url

url: undefined | string

Runtime Url of the Backend.

serializedName

serializedName: string = "BackendUpdateParameters"

type

type: object

className

className: string = "BackendUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

credentials

credentials: object

serializedName

serializedName: string = "properties.credentials"

type

type: object

className

className: string = "BackendCredentialsContract"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties.properties"

type

type: object

className

className: string = "BackendProperties"

name

name: "Composite" = "Composite"

protocol

protocol: object

serializedName

serializedName: string = "properties.protocol"

type

type: object

name

name: "String" = "String"

proxy

proxy: object

serializedName

serializedName: string = "properties.proxy"

type

type: object

className

className: string = "BackendProxyContract"

name

name: "Composite" = "Composite"

resourceId

resourceId: object

serializedName

serializedName: string = "properties.resourceId"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "properties.title"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

tls

tls: object

serializedName

serializedName: string = "properties.tls"

type

type: object

className

className: string = "BackendTlsProperties"

name

name: "Composite" = "Composite"

url

url: object

serializedName

serializedName: string = "properties.url"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const BodyDiagnosticSettings

BodyDiagnosticSettings: object

Body logging settings.

Optional bytes

bytes: undefined | number

Number of request body bytes to log.

serializedName

serializedName: string = "BodyDiagnosticSettings"

type

type: object

className

className: string = "BodyDiagnosticSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bytes

bytes: object

serializedName

serializedName: string = "bytes"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 8192

type

type: object

name

name: "Number" = "Number"

Const CacheCollection

CacheCollection: object
interface

Paged Caches list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "CacheCollection"

__@iterator

  • Iterator

    Returns IterableIterator<CacheContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CacheContract>[]

      Additional items to add to the end of array1.

    Returns CacheContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CacheContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CacheContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: CacheContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CacheContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CacheContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CacheContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CacheContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns CacheContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: CacheContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CacheContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: CacheContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CacheContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CacheContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CacheContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns CacheContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns CacheContract

  • Parameters

    Returns CacheContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns CacheContract

  • Parameters

    Returns CacheContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns CacheContract[]

shift

  • Removes the first element from an array and returns it.

    Returns CacheContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): CacheContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CacheContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CacheContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CacheContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns CacheContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CacheContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<CacheContract>

type

type: object

className

className: string = "CacheCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CacheContract"

name

name: "Composite" = "Composite"

Const CacheContract

CacheContract: object

Cache details.

connectionString

connectionString: string

Runtime connection string to cache

Optional description

description: undefined | string

Cache description

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceId

resourceId: undefined | string

Original uri of entity in external system cache points to

serializedName

serializedName: string = "CacheContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "CacheContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "properties.connectionString"

constraints

constraints: object

MaxLength

MaxLength: number = 300

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "properties.resourceId"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

type

type: object

name

name: "String" = "String"

Const CacheCreateOrUpdateHeaders

CacheCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "cache-createorupdate-headers"

type

type: object

className

className: string = "CacheCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const CacheGetEntityTagHeaders

CacheGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "cache-getentitytag-headers"

type

type: object

className

className: string = "CacheGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const CacheGetHeaders

CacheGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "cache-get-headers"

type

type: object

className

className: string = "CacheGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const CacheUpdateParameters

CacheUpdateParameters: object

Cache update details.

Optional connectionString

connectionString: undefined | string

Runtime connection string to cache

Optional description

description: undefined | string

Cache description

Optional resourceId

resourceId: undefined | string

Original uri of entity in external system cache points to

serializedName

serializedName: string = "CacheUpdateParameters"

type

type: object

className

className: string = "CacheUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "properties.connectionString"

constraints

constraints: object

MaxLength

MaxLength: number = 300

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "properties.resourceId"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

type

type: object

name

name: "String" = "String"

Const CertificateCollection

CertificateCollection: object
interface

Paged Certificates list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "CertificateCollection"

__@iterator

  • Iterator

    Returns IterableIterator<CertificateContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CertificateContract>[]

      Additional items to add to the end of array1.

    Returns CertificateContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CertificateContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CertificateContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CertificateContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CertificateContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CertificateContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CertificateContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns CertificateContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CertificateContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CertificateContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CertificateContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns CertificateContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns CertificateContract

  • Parameters

    Returns CertificateContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns CertificateContract

  • Parameters

    Returns CertificateContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns CertificateContract[]

shift

  • Removes the first element from an array and returns it.

    Returns CertificateContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CertificateContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CertificateContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CertificateContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns CertificateContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<CertificateContract>

type

type: object

className

className: string = "CertificateCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateContract"

name

name: "Composite" = "Composite"

Const CertificateConfiguration

CertificateConfiguration: object

Certificate configuration which consist of non-trusted intermediates and root certificates.

Optional certificate

certificate: CertificateInformation

Certificate information.

Optional certificatePassword

certificatePassword: undefined | string

Certificate Password.

Optional encodedCertificate

encodedCertificate: undefined | string

Base64 Encoded certificate.

storeName

storeName: StoreName

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. Possible values include: 'CertificateAuthority', 'Root'

serializedName

serializedName: string = "CertificateConfiguration"

type

type: object

className

className: string = "CertificateConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

certificate

certificate: object

serializedName

serializedName: string = "certificate"

type

type: object

className

className: string = "CertificateInformation"

name

name: "Composite" = "Composite"

certificatePassword

certificatePassword: object

serializedName

serializedName: string = "certificatePassword"

type

type: object

name

name: "String" = "String"

encodedCertificate

encodedCertificate: object

serializedName

serializedName: string = "encodedCertificate"

type

type: object

name

name: "String" = "String"

storeName

storeName: object

required

required: true = true

serializedName

serializedName: string = "storeName"

type

type: object

name

name: "String" = "String"

Const CertificateContract

CertificateContract: object

Certificate details.

expirationDate

expirationDate: Date

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

subject

subject: string

Subject attribute of the certificate.

thumbprint

thumbprint: string

Thumbprint of the certificate.

serializedName

serializedName: string = "CertificateContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "CertificateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expirationDate

expirationDate: object

required

required: true = true

serializedName

serializedName: string = "properties.expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

subject

subject: object

required

required: true = true

serializedName

serializedName: string = "properties.subject"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

required

required: true = true

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

Const CertificateCreateOrUpdateHeaders

CertificateCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "certificate-createorupdate-headers"

type

type: object

className

className: string = "CertificateCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const CertificateCreateOrUpdateParameters

CertificateCreateOrUpdateParameters: object

Certificate create or update details.

data

data: string

Base 64 encoded certificate using the application/x-pkcs12 representation.

password

password: string

Password for the Certificate

serializedName

serializedName: string = "CertificateCreateOrUpdateParameters"

type

type: object

className

className: string = "CertificateCreateOrUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

data

data: object

required

required: true = true

serializedName

serializedName: string = "properties.data"

type

type: object

name

name: "String" = "String"

password

password: object

required

required: true = true

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

Const CertificateGetEntityTagHeaders

CertificateGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "certificate-getentitytag-headers"

type

type: object

className

className: string = "CertificateGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const CertificateGetHeaders

CertificateGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "certificate-get-headers"

type

type: object

className

className: string = "CertificateGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const CertificateInformation

CertificateInformation: object

SSL certificate information.

expiry

expiry: Date

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

subject

subject: string

Subject of the certificate.

thumbprint

thumbprint: string

Thumbprint of the certificate.

serializedName

serializedName: string = "CertificateInformation"

type

type: object

className

className: string = "CertificateInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiry

expiry: object

required

required: true = true

serializedName

serializedName: string = "expiry"

type

type: object

name

name: "DateTime" = "DateTime"

subject

subject: object

required

required: true = true

serializedName

serializedName: string = "subject"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

required

required: true = true

serializedName

serializedName: string = "thumbprint"

type

type: object

name

name: "String" = "String"

Const ConnectivityStatusContract

ConnectivityStatusContract: object

Details about connectivity to a resource.

Optional error

error: undefined | string

Error details of the connectivity to the resource.

lastStatusChange

lastStatusChange: Date

The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

lastUpdated

lastUpdated: Date

The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

name

name: string

The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon.

status

status: ConnectivityStatusType

Resource Connectivity Status Type identifier. Possible values include: 'initializing', 'success', 'failure'

serializedName

serializedName: string = "ConnectivityStatusContract"

type

type: object

className

className: string = "ConnectivityStatusContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

name

name: "String" = "String"

lastStatusChange

lastStatusChange: object

required

required: true = true

serializedName

serializedName: string = "lastStatusChange"

type

type: object

name

name: "DateTime" = "DateTime"

lastUpdated

lastUpdated: object

required

required: true = true

serializedName

serializedName: string = "lastUpdated"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

status

status: object

required

required: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const DelegationSettingsGetEntityTagHeaders

DelegationSettingsGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "delegationsettings-getentitytag-headers"

type

type: object

className

className: string = "DelegationSettingsGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const DelegationSettingsGetHeaders

DelegationSettingsGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "delegationsettings-get-headers"

type

type: object

className

className: string = "DelegationSettingsGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const DeployConfigurationParameters

DeployConfigurationParameters: object

Deploy Tenant Configuration Contract.

branch

branch: string

The name of the Git branch from which the configuration is to be deployed to the configuration database.

Optional force

force: undefined | false | true

The value enforcing deleting subscriptions to products that are deleted in this update.

serializedName

serializedName: string = "DeployConfigurationParameters"

type

type: object

className

className: string = "DeployConfigurationParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

branch

branch: object

required

required: true = true

serializedName

serializedName: string = "properties.branch"

type

type: object

name

name: "String" = "String"

force

force: object

serializedName

serializedName: string = "properties.force"

type

type: object

name

name: "Boolean" = "Boolean"

Const DiagnosticCollection

DiagnosticCollection: object
interface

Paged Diagnostic list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "DiagnosticCollection"

__@iterator

  • Iterator

    Returns IterableIterator<DiagnosticContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DiagnosticContract>[]

      Additional items to add to the end of array1.

    Returns DiagnosticContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DiagnosticContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DiagnosticContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DiagnosticContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DiagnosticContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DiagnosticContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DiagnosticContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DiagnosticContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns DiagnosticContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DiagnosticContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DiagnosticContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DiagnosticContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns DiagnosticContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DiagnosticContract

  • Parameters

    Returns DiagnosticContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DiagnosticContract

  • Parameters

    Returns DiagnosticContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns DiagnosticContract[]

shift

  • Removes the first element from an array and returns it.

    Returns DiagnosticContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DiagnosticContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DiagnosticContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DiagnosticContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns DiagnosticContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<DiagnosticContract>

type

type: object

className

className: string = "DiagnosticCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DiagnosticContract"

name

name: "Composite" = "Composite"

Const DiagnosticContract

DiagnosticContract: object

Diagnostic details.

Optional alwaysLog

alwaysLog: AlwaysLog

Specifies for what type of messages sampling settings should not apply. Possible values include: 'allErrors'

Optional backend

backend: PipelineDiagnosticSettings

Diagnostic settings for incoming/outgoing HTTP messages to the Backend

Optional enableHttpCorrelationHeaders

enableHttpCorrelationHeaders: undefined | false | true

Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true.

Optional frontend

frontend: PipelineDiagnosticSettings

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

loggerId

loggerId: string

Resource Id of a target logger.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sampling

sampling: SamplingSettings

Sampling settings for Diagnostic.

serializedName

serializedName: string = "DiagnosticContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "DiagnosticContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

alwaysLog

alwaysLog: object

serializedName

serializedName: string = "properties.alwaysLog"

type

type: object

name

name: "String" = "String"

backend

backend: object

serializedName

serializedName: string = "properties.backend"

type

type: object

className

className: string = "PipelineDiagnosticSettings"

name

name: "Composite" = "Composite"

enableHttpCorrelationHeaders

enableHttpCorrelationHeaders: object

serializedName

serializedName: string = "properties.enableHttpCorrelationHeaders"

type

type: object

name

name: "Boolean" = "Boolean"

frontend

frontend: object

serializedName

serializedName: string = "properties.frontend"

type

type: object

className

className: string = "PipelineDiagnosticSettings"

name

name: "Composite" = "Composite"

loggerId

loggerId: object

required

required: true = true

serializedName

serializedName: string = "properties.loggerId"

type

type: object

name

name: "String" = "String"

sampling

sampling: object

serializedName

serializedName: string = "properties.sampling"

type

type: object

className

className: string = "SamplingSettings"

name

name: "Composite" = "Composite"

Const DiagnosticCreateOrUpdateHeaders

DiagnosticCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "diagnostic-createorupdate-headers"

type

type: object

className

className: string = "DiagnosticCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const DiagnosticGetEntityTagHeaders

DiagnosticGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "diagnostic-getentitytag-headers"

type

type: object

className

className: string = "DiagnosticGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const DiagnosticGetHeaders

DiagnosticGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "diagnostic-get-headers"

type

type: object

className

className: string = "DiagnosticGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const EmailTemplateCollection

EmailTemplateCollection: object
interface

Paged email template list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "EmailTemplateCollection"

__@iterator

  • Iterator

    Returns IterableIterator<EmailTemplateContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns EmailTemplateContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns EmailTemplateContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, EmailTemplateContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: EmailTemplateContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): EmailTemplateContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns EmailTemplateContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): EmailTemplateContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns EmailTemplateContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: EmailTemplateContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: EmailTemplateContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: EmailTemplateContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns EmailTemplateContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns EmailTemplateContract

  • Parameters

    Returns EmailTemplateContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns EmailTemplateContract[]

shift

  • Removes the first element from an array and returns it.

    Returns EmailTemplateContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns EmailTemplateContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns EmailTemplateContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: EmailTemplateContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns EmailTemplateContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<EmailTemplateContract>

type

type: object

className

className: string = "EmailTemplateCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailTemplateContract"

name

name: "Composite" = "Composite"

Const EmailTemplateContract

EmailTemplateContract: object

Email Template details.

body

body: string

Email Template Body. This should be a valid XDocument

Optional description

description: undefined | string

Description of the Email Template.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDefault

isDefault: undefined | false | true

Whether the template is the default template provided by Api Management or has been edited. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: EmailTemplateParametersContractProperties[]

Email Template Parameter values.

subject

subject: string

Subject of the Template.

Optional title

title: undefined | string

Title of the Template.

serializedName

serializedName: string = "EmailTemplateContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "EmailTemplateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

body

body: object

required

required: true = true

serializedName

serializedName: string = "properties.body"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isDefault

isDefault: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isDefault"

type

type: object

name

name: "Boolean" = "Boolean"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailTemplateParametersContractProperties"

name

name: "Composite" = "Composite"

subject

subject: object

required

required: true = true

serializedName

serializedName: string = "properties.subject"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "properties.title"

type

type: object

name

name: "String" = "String"

Const EmailTemplateGetEntityTagHeaders

EmailTemplateGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "emailtemplate-getentitytag-headers"

type

type: object

className

className: string = "EmailTemplateGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const EmailTemplateGetHeaders

EmailTemplateGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "emailtemplate-get-headers"

type

type: object

className

className: string = "EmailTemplateGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const EmailTemplateParametersContractProperties

EmailTemplateParametersContractProperties: object

Email Template Parameter contract.

Optional description

description: undefined | string

Template parameter description.

Optional name

name: undefined | string

Template parameter name.

Optional title

title: undefined | string

Template parameter title.

serializedName

serializedName: string = "EmailTemplateParametersContractProperties"

type

type: object

className

className: string = "EmailTemplateParametersContractProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9-._]+$/

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9-._]+$/

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "title"

constraints

constraints: object

MaxLength

MaxLength: number = 4096

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const EmailTemplateUpdateParameters

EmailTemplateUpdateParameters: object

Email Template update Parameters.

Optional body

body: undefined | string

Email Template Body. This should be a valid XDocument

Optional description

description: undefined | string

Description of the Email Template.

Optional parameters

parameters: EmailTemplateParametersContractProperties[]

Email Template Parameter values.

Optional subject

subject: undefined | string

Subject of the Template.

Optional title

title: undefined | string

Title of the Template.

serializedName

serializedName: string = "EmailTemplateUpdateParameters"

type

type: object

className

className: string = "EmailTemplateUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

body

body: object

serializedName

serializedName: string = "properties.body"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailTemplateParametersContractProperties"

name

name: "Composite" = "Composite"

subject

subject: object

serializedName

serializedName: string = "properties.subject"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "properties.title"

type

type: object

name

name: "String" = "String"

Const ErrorFieldContract

ErrorFieldContract: object

Error Field contract.

Optional code

code: undefined | string

Property level error code.

Optional message

message: undefined | string

Human-readable representation of property-level error.

Optional target

target: undefined | string

Property name.

serializedName

serializedName: string = "ErrorFieldContract"

type

type: object

className

className: string = "ErrorFieldContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const ErrorResponse

ErrorResponse: object

Error Response.

Optional code

code: undefined | string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

Optional details

details: ErrorFieldContract[]

The list of invalid fields send in request, in case of validation error.

Optional message

message: undefined | string

Human-readable representation of the error.

serializedName

serializedName: string = "ErrorResponse"

type

type: object

className

className: string = "ErrorResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "error.code"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "error.details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorFieldContract"

name

name: "Composite" = "Composite"

message

message: object

serializedName

serializedName: string = "error.message"

type

type: object

name

name: "String" = "String"

Const ErrorResponseBody

ErrorResponseBody: object

Error Body contract.

Optional code

code: undefined | string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

Optional details

details: ErrorFieldContract[]

The list of invalid fields send in request, in case of validation error.

Optional message

message: undefined | string

Human-readable representation of the error.

serializedName

serializedName: string = "ErrorResponseBody"

type

type: object

className

className: string = "ErrorResponseBody"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorFieldContract"

name

name: "Composite" = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const GenerateSsoUrlResult

GenerateSsoUrlResult: object

Generate SSO Url operations response details.

Optional value

value: undefined | string

Redirect Url containing the SSO URL value.

serializedName

serializedName: string = "GenerateSsoUrlResult"

type

type: object

className

className: string = "GenerateSsoUrlResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const GroupCollection

GroupCollection: object
interface

Paged Group list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "GroupCollection"

__@iterator

  • Iterator

    Returns IterableIterator<GroupContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<GroupContract>[]

      Additional items to add to the end of array1.

    Returns GroupContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns GroupContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, GroupContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: GroupContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: GroupContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): GroupContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns GroupContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): GroupContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns GroupContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: GroupContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: GroupContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: GroupContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: GroupContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: GroupContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: GroupContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns GroupContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns GroupContract

  • Parameters

    Returns GroupContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns GroupContract

  • Parameters

    Returns GroupContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns GroupContract[]

shift

  • Removes the first element from an array and returns it.

    Returns GroupContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): GroupContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns GroupContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns GroupContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: GroupContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns GroupContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: GroupContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<GroupContract>

type

type: object

className

className: string = "GroupCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GroupContract"

name

name: "Composite" = "Composite"

Const GroupContract

GroupContract: object

Contract details.

Optional builtIn

builtIn: undefined | false | true

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

Group description. Can contain HTML formatting tags.

displayName

displayName: string

Group name.

Optional externalId

externalId: undefined | string

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

Optional groupContractType

groupContractType: GroupType

Group type. Possible values include: 'custom', 'system', 'external'

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "GroupContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "GroupContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

builtIn

builtIn: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.builtIn"

type

type: object

name

name: "Boolean" = "Boolean"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

type

type: object

name

name: "String" = "String"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

externalId

externalId: object

serializedName

serializedName: string = "properties.externalId"

type

type: object

name

name: "String" = "String"

groupContractType

groupContractType: object

serializedName

serializedName: string = "properties.type"

type

type: object

allowedValues

allowedValues: string[] = ["custom","system","external"]

name

name: "Enum" = "Enum"

Const GroupContractProperties

GroupContractProperties: object

Group contract Properties.

Optional builtIn

builtIn: undefined | false | true

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

Group description. Can contain HTML formatting tags.

displayName

displayName: string

Group name.

Optional externalId

externalId: undefined | string

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

serializedName

serializedName: string = "GroupContractProperties"

Optional type

type: object

Group type. Possible values include: 'custom', 'system', 'external'

className

className: string = "GroupContractProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

builtIn

builtIn: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "builtIn"

type

type: object

name

name: "Boolean" = "Boolean"

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

type

type: object

name

name: "String" = "String"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

externalId

externalId: object

serializedName

serializedName: string = "externalId"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["custom","system","external"]

name

name: "Enum" = "Enum"

Const GroupCreateOrUpdateHeaders

GroupCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "group-createorupdate-headers"

type

type: object

className

className: string = "GroupCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const GroupCreateParameters

GroupCreateParameters: object

Parameters supplied to the Create Group operation.

Optional description

description: undefined | string

Group description.

displayName

displayName: string

Group name.

Optional externalId

externalId: undefined | string

Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

serializedName

serializedName: string = "GroupCreateParameters"

Optional type

type: object

Group type. Possible values include: 'custom', 'system', 'external'

className

className: string = "GroupCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

externalId

externalId: object

serializedName

serializedName: string = "properties.externalId"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "properties.type"

type

type: object

allowedValues

allowedValues: string[] = ["custom","system","external"]

name

name: "Enum" = "Enum"

Const GroupGetEntityTagHeaders

GroupGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "group-getentitytag-headers"

type

type: object

className

className: string = "GroupGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const GroupGetHeaders

GroupGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "group-get-headers"

type

type: object

className

className: string = "GroupGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const GroupUpdateParameters

GroupUpdateParameters: object

Parameters supplied to the Update Group operation.

Optional description

description: undefined | string

Group description.

Optional displayName

displayName: undefined | string

Group name.

Optional externalId

externalId: undefined | string

Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

serializedName

serializedName: string = "GroupUpdateParameters"

Optional type

type: object

Group type. Possible values include: 'custom', 'system', 'external'

className

className: string = "GroupUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

externalId

externalId: object

serializedName

serializedName: string = "properties.externalId"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "properties.type"

type

type: object

allowedValues

allowedValues: string[] = ["custom","system","external"]

name

name: "Enum" = "Enum"

Const HostnameConfiguration

HostnameConfiguration: object

Custom hostname configuration.

Optional certificate

certificate: CertificateInformation

Certificate information.

Optional certificatePassword

certificatePassword: undefined | string

Certificate Password.

Optional defaultSslBinding

defaultSslBinding: undefined | false | true

Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type. Default value: false.

Optional encodedCertificate

encodedCertificate: undefined | string

Base64 Encoded certificate.

hostName

hostName: string

Hostname to configure on the Api Management service.

Optional keyVaultId

keyVaultId: undefined | string

Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type application/x-pkcs12

Optional negotiateClientCertificate

negotiateClientCertificate: undefined | false | true

Specify true to always negotiate client certificate on the hostname. Default Value is false. Default value: false.

serializedName

serializedName: string = "HostnameConfiguration"

type

type: object

Hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm', 'DeveloperPortal'

className

className: string = "HostnameConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

certificate

certificate: object

serializedName

serializedName: string = "certificate"

type

type: object

className

className: string = "CertificateInformation"

name

name: "Composite" = "Composite"

certificatePassword

certificatePassword: object

serializedName

serializedName: string = "certificatePassword"

type

type: object

name

name: "String" = "String"

defaultSslBinding

defaultSslBinding: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "defaultSslBinding"

type

type: object

name

name: "Boolean" = "Boolean"

encodedCertificate

encodedCertificate: object

serializedName

serializedName: string = "encodedCertificate"

type

type: object

name

name: "String" = "String"

hostName

hostName: object

required

required: true = true

serializedName

serializedName: string = "hostName"

type

type: object

name

name: "String" = "String"

keyVaultId

keyVaultId: object

serializedName

serializedName: string = "keyVaultId"

type

type: object

name

name: "String" = "String"

negotiateClientCertificate

negotiateClientCertificate: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "negotiateClientCertificate"

type

type: object

name

name: "Boolean" = "Boolean"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const HttpMessageDiagnostic

HttpMessageDiagnostic: object

Http message diagnostic settings.

Optional body

body: BodyDiagnosticSettings

Body logging settings.

Optional headers

headers: string[]

Array of HTTP Headers to log.

serializedName

serializedName: string = "HttpMessageDiagnostic"

type

type: object

className

className: string = "HttpMessageDiagnostic"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

body

body: object

serializedName

serializedName: string = "body"

type

type: object

className

className: string = "BodyDiagnosticSettings"

name

name: "Composite" = "Composite"

headers

headers: object

serializedName

serializedName: string = "headers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const IdentityProviderBaseParameters

IdentityProviderBaseParameters: object

Identity Provider Base Parameter Properties.

Optional allowedTenants

allowedTenants: string[]

List of Allowed Tenants when configuring Azure Active Directory login.

Optional authority

authority: undefined | string

OpenID Connect discovery endpoint hostname for AAD or AAD B2C.

Optional passwordResetPolicyName

passwordResetPolicyName: undefined | string

Password Reset Policy Name. Only applies to AAD B2C Identity Provider.

Optional profileEditingPolicyName

profileEditingPolicyName: undefined | string

Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.

Optional signinPolicyName

signinPolicyName: undefined | string

Signin Policy Name. Only applies to AAD B2C Identity Provider.

Optional signupPolicyName

signupPolicyName: undefined | string

Signup Policy Name. Only applies to AAD B2C Identity Provider.

serializedName

serializedName: string = "IdentityProviderBaseParameters"

Optional type

type: object

Identity Provider Type identifier. Possible values include: 'facebook', 'google', 'microsoft', 'twitter', 'aad', 'aadB2C'

className

className: string = "IdentityProviderBaseParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedTenants

allowedTenants: object

serializedName

serializedName: string = "allowedTenants"

constraints

constraints: object

MaxItems

MaxItems: number = 32

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

authority

authority: object

serializedName

serializedName: string = "authority"

type

type: object

name

name: "String" = "String"

passwordResetPolicyName

passwordResetPolicyName: object

serializedName

serializedName: string = "passwordResetPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

profileEditingPolicyName

profileEditingPolicyName: object

serializedName

serializedName: string = "profileEditingPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

signinPolicyName

signinPolicyName: object

serializedName

serializedName: string = "signinPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

signupPolicyName

signupPolicyName: object

serializedName

serializedName: string = "signupPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const IdentityProviderContract

IdentityProviderContract: object

Identity Provider details.

Optional allowedTenants

allowedTenants: string[]

List of Allowed Tenants when configuring Azure Active Directory login.

Optional authority

authority: undefined | string

OpenID Connect discovery endpoint hostname for AAD or AAD B2C.

clientId

clientId: string

Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.

clientSecret

clientSecret: string

Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identityProviderContractType

identityProviderContractType: IdentityProviderType

Identity Provider Type identifier. Possible values include: 'facebook', 'google', 'microsoft', 'twitter', 'aad', 'aadB2C'

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional passwordResetPolicyName

passwordResetPolicyName: undefined | string

Password Reset Policy Name. Only applies to AAD B2C Identity Provider.

Optional profileEditingPolicyName

profileEditingPolicyName: undefined | string

Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.

Optional signinPolicyName

signinPolicyName: undefined | string

Signin Policy Name. Only applies to AAD B2C Identity Provider.

Optional signupPolicyName

signupPolicyName: undefined | string

Signup Policy Name. Only applies to AAD B2C Identity Provider.

serializedName

serializedName: string = "IdentityProviderContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IdentityProviderContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedTenants

allowedTenants: object

serializedName

serializedName: string = "properties.allowedTenants"

constraints

constraints: object

MaxItems

MaxItems: number = 32

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

authority

authority: object

serializedName

serializedName: string = "properties.authority"

type

type: object

name

name: "String" = "String"

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "properties.clientId"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

clientSecret

clientSecret: object

required

required: true = true

serializedName

serializedName: string = "properties.clientSecret"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

identityProviderContractType

identityProviderContractType: object

serializedName

serializedName: string = "properties.type"

type

type: object

name

name: "String" = "String"

passwordResetPolicyName

passwordResetPolicyName: object

serializedName

serializedName: string = "properties.passwordResetPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

profileEditingPolicyName

profileEditingPolicyName: object

serializedName

serializedName: string = "properties.profileEditingPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

signinPolicyName

signinPolicyName: object

serializedName

serializedName: string = "properties.signinPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

signupPolicyName

signupPolicyName: object

serializedName

serializedName: string = "properties.signupPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const IdentityProviderCreateOrUpdateHeaders

IdentityProviderCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "identityprovider-createorupdate-headers"

type

type: object

className

className: string = "IdentityProviderCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const IdentityProviderGetEntityTagHeaders

IdentityProviderGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "identityprovider-getentitytag-headers"

type

type: object

className

className: string = "IdentityProviderGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const IdentityProviderGetHeaders

IdentityProviderGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "identityprovider-get-headers"

type

type: object

className

className: string = "IdentityProviderGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const IdentityProviderList

IdentityProviderList: object
interface

List of all the Identity Providers configured on the service instance.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "IdentityProviderList"

__@iterator

  • Iterator

    Returns IterableIterator<IdentityProviderContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IdentityProviderContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IdentityProviderContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IdentityProviderContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IdentityProviderContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): IdentityProviderContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns IdentityProviderContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IdentityProviderContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IdentityProviderContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IdentityProviderContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IdentityProviderContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IdentityProviderContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IdentityProviderContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns IdentityProviderContract[]

shift

  • Removes the first element from an array and returns it.

    Returns IdentityProviderContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IdentityProviderContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IdentityProviderContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IdentityProviderContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns IdentityProviderContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IdentityProviderContract>

type

type: object

className

className: string = "IdentityProviderList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IdentityProviderContract"

name

name: "Composite" = "Composite"

Const IdentityProviderUpdateParameters

IdentityProviderUpdateParameters: object

Parameters supplied to update Identity Provider

Optional allowedTenants

allowedTenants: string[]

List of Allowed Tenants when configuring Azure Active Directory login.

Optional authority

authority: undefined | string

OpenID Connect discovery endpoint hostname for AAD or AAD B2C.

Optional clientId

clientId: undefined | string

Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.

Optional clientSecret

clientSecret: undefined | string

Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.

Optional passwordResetPolicyName

passwordResetPolicyName: undefined | string

Password Reset Policy Name. Only applies to AAD B2C Identity Provider.

Optional profileEditingPolicyName

profileEditingPolicyName: undefined | string

Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.

Optional signinPolicyName

signinPolicyName: undefined | string

Signin Policy Name. Only applies to AAD B2C Identity Provider.

Optional signupPolicyName

signupPolicyName: undefined | string

Signup Policy Name. Only applies to AAD B2C Identity Provider.

serializedName

serializedName: string = "IdentityProviderUpdateParameters"

Optional type

type: object

Identity Provider Type identifier. Possible values include: 'facebook', 'google', 'microsoft', 'twitter', 'aad', 'aadB2C'

className

className: string = "IdentityProviderUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedTenants

allowedTenants: object

serializedName

serializedName: string = "properties.allowedTenants"

constraints

constraints: object

MaxItems

MaxItems: number = 32

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

authority

authority: object

serializedName

serializedName: string = "properties.authority"

type

type: object

name

name: "String" = "String"

clientId

clientId: object

serializedName

serializedName: string = "properties.clientId"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

clientSecret

clientSecret: object

serializedName

serializedName: string = "properties.clientSecret"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

passwordResetPolicyName

passwordResetPolicyName: object

serializedName

serializedName: string = "properties.passwordResetPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

profileEditingPolicyName

profileEditingPolicyName: object

serializedName

serializedName: string = "properties.profileEditingPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

signinPolicyName

signinPolicyName: object

serializedName

serializedName: string = "properties.signinPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

signupPolicyName

signupPolicyName: object

serializedName

serializedName: string = "properties.signupPolicyName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "properties.type"

type

type: object

name

name: "String" = "String"

Const IssueAttachmentCollection

IssueAttachmentCollection: object
interface

Paged Issue Attachment list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IssueAttachmentCollection"

__@iterator

  • Iterator

    Returns IterableIterator<IssueAttachmentContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IssueAttachmentContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IssueAttachmentContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IssueAttachmentContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IssueAttachmentContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): IssueAttachmentContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns IssueAttachmentContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IssueAttachmentContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IssueAttachmentContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IssueAttachmentContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IssueAttachmentContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IssueAttachmentContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IssueAttachmentContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns IssueAttachmentContract[]

shift

  • Removes the first element from an array and returns it.

    Returns IssueAttachmentContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IssueAttachmentContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IssueAttachmentContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IssueAttachmentContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns IssueAttachmentContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IssueAttachmentContract>

type

type: object

className

className: string = "IssueAttachmentCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IssueAttachmentContract"

name

name: "Composite" = "Composite"

Const IssueAttachmentContract

IssueAttachmentContract: object

Issue Attachment Contract details.

content

content: string

An HTTP link or Base64-encoded binary data.

contentFormat

contentFormat: string

Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

title

title: string

Filename by which the binary data will be saved.

serializedName

serializedName: string = "IssueAttachmentContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IssueAttachmentContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

content

content: object

required

required: true = true

serializedName

serializedName: string = "properties.content"

type

type: object

name

name: "String" = "String"

contentFormat

contentFormat: object

required

required: true = true

serializedName

serializedName: string = "properties.contentFormat"

type

type: object

name

name: "String" = "String"

title

title: object

required

required: true = true

serializedName

serializedName: string = "properties.title"

type

type: object

name

name: "String" = "String"

Const IssueCollection

IssueCollection: object
interface

Paged Issue list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IssueCollection"

__@iterator

  • Iterator

    Returns IterableIterator<IssueContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<IssueContract>[]

      Additional items to add to the end of array1.

    Returns IssueContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IssueContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IssueContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: IssueContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IssueContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): IssueContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns IssueContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IssueContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IssueContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: IssueContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IssueContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: IssueContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IssueContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: IssueContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IssueContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IssueContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns IssueContract

  • Parameters

    Returns IssueContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns IssueContract

  • Parameters

    Returns IssueContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns IssueContract[]

shift

  • Removes the first element from an array and returns it.

    Returns IssueContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): IssueContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IssueContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IssueContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IssueContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns IssueContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: IssueContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IssueContract>

type

type: object

className

className: string = "IssueCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IssueContract"

name

name: "Composite" = "Composite"

Const IssueCommentCollection

IssueCommentCollection: object
interface

Paged Issue Comment list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IssueCommentCollection"

__@iterator

  • Iterator

    Returns IterableIterator<IssueCommentContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IssueCommentContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IssueCommentContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IssueCommentContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IssueCommentContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): IssueCommentContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns IssueCommentContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IssueCommentContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IssueCommentContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IssueCommentContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IssueCommentContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IssueCommentContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IssueCommentContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns IssueCommentContract

  • Parameters

    Returns IssueCommentContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns IssueCommentContract

  • Parameters

    Returns IssueCommentContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns IssueCommentContract[]

shift

  • Removes the first element from an array and returns it.

    Returns IssueCommentContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IssueCommentContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IssueCommentContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IssueCommentContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns IssueCommentContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IssueCommentContract>

type

type: object

className

className: string = "IssueCommentCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IssueCommentContract"

name

name: "Composite" = "Composite"

Const IssueCommentContract

IssueCommentContract: object

Issue Comment Contract details.

Optional createdDate

createdDate: Date

Date and time when the comment was created.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

text

text: string

Comment text.

userId

userId: string

A resource identifier for the user who left the comment.

serializedName

serializedName: string = "IssueCommentContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IssueCommentContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdDate

createdDate: object

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

text

text: object

required

required: true = true

serializedName

serializedName: string = "properties.text"

type

type: object

name

name: "String" = "String"

userId

userId: object

required

required: true = true

serializedName

serializedName: string = "properties.userId"

type

type: object

name

name: "String" = "String"

Const IssueContract

IssueContract: object

Issue Contract details.

Optional apiId

apiId: undefined | string

A resource identifier for the API the issue was created for.

Optional createdDate

createdDate: Date

Date and time when the issue was created.

description

description: string

Text describing the issue.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: State

Status of the issue. Possible values include: 'proposed', 'open', 'removed', 'resolved', 'closed'

title

title: string

The issue title.

userId

userId: string

A resource identifier for the user created the issue.

serializedName

serializedName: string = "IssueContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IssueContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiId

apiId: object

serializedName

serializedName: string = "properties.apiId"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

required

required: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

title

title: object

required

required: true = true

serializedName

serializedName: string = "properties.title"

type

type: object

name

name: "String" = "String"

userId

userId: object

required

required: true = true

serializedName

serializedName: string = "properties.userId"

type

type: object

name

name: "String" = "String"

Const IssueContractBaseProperties

IssueContractBaseProperties: object

Issue contract Base Properties.

Optional apiId

apiId: undefined | string

A resource identifier for the API the issue was created for.

Optional createdDate

createdDate: Date

Date and time when the issue was created.

Optional state

state: State

Status of the issue. Possible values include: 'proposed', 'open', 'removed', 'resolved', 'closed'

serializedName

serializedName: string = "IssueContractBaseProperties"

type

type: object

className

className: string = "IssueContractBaseProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiId

apiId: object

serializedName

serializedName: string = "apiId"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

serializedName

serializedName: string = "createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const IssueGetHeaders

IssueGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "issue-get-headers"

type

type: object

className

className: string = "IssueGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const IssueUpdateContract

IssueUpdateContract: object

Issue update Parameters.

Optional apiId

apiId: undefined | string

A resource identifier for the API the issue was created for.

Optional createdDate

createdDate: Date

Date and time when the issue was created.

Optional description

description: undefined | string

Text describing the issue.

Optional state

state: State

Status of the issue. Possible values include: 'proposed', 'open', 'removed', 'resolved', 'closed'

Optional title

title: undefined | string

The issue title.

Optional userId

userId: undefined | string

A resource identifier for the user created the issue.

serializedName

serializedName: string = "IssueUpdateContract"

type

type: object

className

className: string = "IssueUpdateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiId

apiId: object

serializedName

serializedName: string = "properties.apiId"

type

type: object

name

name: "String" = "String"

createdDate

createdDate: object

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "properties.title"

type

type: object

name

name: "String" = "String"

userId

userId: object

serializedName

serializedName: string = "properties.userId"

type

type: object

name

name: "String" = "String"

Const LoggerCollection

LoggerCollection: object
interface

Paged Logger list representation.

extends

Array

Array

Array: ArrayConstructor

Optional count

count: undefined | number

Total record count number across all pages.

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "LoggerCollection"

__@iterator

  • Iterator

    Returns IterableIterator<LoggerContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LoggerContract>[]

      Additional items to add to the end of array1.

    Returns LoggerContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LoggerContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LoggerContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LoggerContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LoggerContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LoggerContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LoggerContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LoggerContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns LoggerContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LoggerContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LoggerContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LoggerContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LoggerContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LoggerContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LoggerContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns LoggerContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LoggerContract

  • Parameters

    Returns LoggerContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LoggerContract

  • Parameters

    Returns LoggerContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns LoggerContract[]

shift

  • Removes the first element from an array and returns it.

    Returns LoggerContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LoggerContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LoggerContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LoggerContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LoggerContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns LoggerContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LoggerContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<LoggerContract>

type

type: object

className

className: string = "LoggerCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LoggerContract"

name

name: "Composite" = "Composite"

Const LoggerContract

LoggerContract: object

Logger details.

credentials

credentials: object

The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger.

Type declaration

  • [propertyName: string]: string

Optional description

description: undefined | string

Logger description.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isBuffered

isBuffered: undefined | false | true

Whether records are buffered in the logger before publishing. Default is assumed to be true.

loggerType

loggerType: LoggerType

Logger type. Possible values include: 'azureEventHub', 'applicationInsights'

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceId

resourceId: undefined | string

Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).

serializedName

serializedName: string = "LoggerContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "LoggerContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

credentials

credentials: object

required

required: true = true

serializedName

serializedName: string = "properties.credentials"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 256

type

type: object

name

name: "String" = "String"

isBuffered

isBuffered: object

serializedName

serializedName: string = "properties.isBuffered"

type

type: object

name

name: "Boolean" = "Boolean"

loggerType

loggerType: object

required

required: true = true

serializedName

serializedName: string = "properties.loggerType"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "properties.resourceId"

type

type: object

name

name: "String" = "String"

Const LoggerCreateOrUpdateHeaders

LoggerCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "logger-createorupdate-headers"

type

type: object

className

className: string = "LoggerCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const LoggerGetEntityTagHeaders

LoggerGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "logger-getentitytag-headers"

type

type: object

className

className: string = "LoggerGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const LoggerGetHeaders

LoggerGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "logger-get-headers"

type

type: object

className

className: string = "LoggerGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const LoggerUpdateContract

LoggerUpdateContract: object

Logger update contract.

Optional credentials

credentials: undefined | object

Logger credentials.

Optional description

description: undefined | string

Logger description.

Optional isBuffered

isBuffered: undefined | false | true

Whether records are buffered in the logger before publishing. Default is assumed to be true.

Optional loggerType

loggerType: LoggerType

Logger type. Possible values include: 'azureEventHub', 'applicationInsights'

serializedName

serializedName: string = "LoggerUpdateContract"

type

type: object

className

className: string = "LoggerUpdateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

credentials

credentials: object

serializedName

serializedName: string = "properties.credentials"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

isBuffered

isBuffered: object

serializedName

serializedName: string = "properties.isBuffered"

type

type: object

name

name: "Boolean" = "Boolean"

loggerType

loggerType: object

serializedName

serializedName: string = "properties.loggerType"

type

type: object

name

name: "String" = "String"

Const NetworkStatusContract

NetworkStatusContract: object

Network Status details.

connectivityStatus

connectivityStatus: ConnectivityStatusContract[]

Gets the list of Connectivity Status to the Resources on which the service depends upon.

dnsServers

dnsServers: string[]

Gets the list of DNS servers IPV4 addresses.

serializedName

serializedName: string = "NetworkStatusContract"

type

type: object

className

className: string = "NetworkStatusContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectivityStatus

connectivityStatus: object

required

required: true = true

serializedName

serializedName: string = "connectivityStatus"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectivityStatusContract"

name

name: "Composite" = "Composite"

dnsServers

dnsServers: object

required

required: true = true

serializedName

serializedName: string = "dnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const NetworkStatusContractByLocation

NetworkStatusContractByLocation: object

Network Status in the Location

Optional location

location: undefined | string

Location of service

Optional networkStatus

networkStatus: NetworkStatusContract

Network status in Location

serializedName

serializedName: string = "NetworkStatusContractByLocation"

type

type: object

className

className: string = "NetworkStatusContractByLocation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

networkStatus

networkStatus: object

serializedName

serializedName: string = "networkStatus"

type

type: object

className

className: string = "NetworkStatusContract"

name

name: "Composite" = "Composite"

Const NotificationCollection

NotificationCollection: object
interface

Paged Notification list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "NotificationCollection"

__@iterator

  • Iterator

    Returns IterableIterator<NotificationContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns NotificationContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NotificationContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NotificationContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NotificationContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NotificationContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NotificationContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NotificationContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns NotificationContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NotificationContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NotificationContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NotificationContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns NotificationContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns NotificationContract

  • Parameters

    Returns NotificationContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns NotificationContract

  • Parameters

    Returns NotificationContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns NotificationContract[]

shift

  • Removes the first element from an array and returns it.

    Returns NotificationContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NotificationContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NotificationContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NotificationContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns NotificationContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<NotificationContract>

type

type: object

className

className: string = "NotificationCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NotificationContract"

name

name: "Composite" = "Composite"

Const NotificationContract

NotificationContract: object

Notification details.

Optional description

description: undefined | string

Description of the Notification.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recipients

recipients: RecipientsContractProperties

Recipient Parameter values.

title

title: string

Title of the Notification.

serializedName

serializedName: string = "NotificationContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "NotificationContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

recipients

recipients: object

serializedName

serializedName: string = "properties.recipients"

type

type: object

className

className: string = "RecipientsContractProperties"

name

name: "Composite" = "Composite"

title

title: object

required

required: true = true

serializedName

serializedName: string = "properties.title"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const OAuth2AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract: object

API OAuth2 Authentication settings details.

Optional authorizationServerId

authorizationServerId: undefined | string

OAuth authorization server identifier.

Optional scope

scope: undefined | string

operations scope.

serializedName

serializedName: string = "OAuth2AuthenticationSettingsContract"

type

type: object

className

className: string = "OAuth2AuthenticationSettingsContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationServerId

authorizationServerId: object

serializedName

serializedName: string = "authorizationServerId"

type

type: object

name

name: "String" = "String"

scope

scope: object

serializedName

serializedName: string = "scope"

type

type: object

name

name: "String" = "String"

Const OpenIdAuthenticationSettingsContract

OpenIdAuthenticationSettingsContract: object

API OAuth2 Authentication settings details.

Optional bearerTokenSendingMethods

bearerTokenSendingMethods: BearerTokenSendingMethods[]

How to send token to the server.

Optional openidProviderId

openidProviderId: undefined | string

OAuth authorization server identifier.

serializedName

serializedName: string = "OpenIdAuthenticationSettingsContract"

type

type: object

className

className: string = "OpenIdAuthenticationSettingsContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bearerTokenSendingMethods

bearerTokenSendingMethods: object

serializedName

serializedName: string = "bearerTokenSendingMethods"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

openidProviderId

openidProviderId: object

serializedName

serializedName: string = "openidProviderId"

type

type: object

name

name: "String" = "String"

Const OpenIdConnectProviderCollection

OpenIdConnectProviderCollection: object
interface

Paged OpenIdProviders list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "OpenIdConnectProviderCollection"

__@iterator

  • Iterator

    Returns IterableIterator<OpenidConnectProviderContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns OpenidConnectProviderContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns OpenidConnectProviderContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, OpenidConnectProviderContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: OpenidConnectProviderContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns OpenidConnectProviderContract[]

find

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: OpenidConnectProviderContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: OpenidConnectProviderContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: OpenidConnectProviderContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns OpenidConnectProviderContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns OpenidConnectProviderContract[]

shift

  • Removes the first element from an array and returns it.

    Returns OpenidConnectProviderContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns OpenidConnectProviderContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns OpenidConnectProviderContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: OpenidConnectProviderContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns OpenidConnectProviderContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<OpenidConnectProviderContract>

type

type: object

className

className: string = "OpenIdConnectProviderCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OpenidConnectProviderContract"

name

name: "Composite" = "Composite"

Const OpenIdConnectProviderCreateOrUpdateHeaders

OpenIdConnectProviderCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "openidconnectprovider-createorupdate-headers"

type

type: object

className

className: string = "OpenIdConnectProviderCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const OpenIdConnectProviderGetEntityTagHeaders

OpenIdConnectProviderGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "openidconnectprovider-getentitytag-headers"

type

type: object

className

className: string = "OpenIdConnectProviderGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const OpenIdConnectProviderGetHeaders

OpenIdConnectProviderGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "openidconnectprovider-get-headers"

type

type: object

className

className: string = "OpenIdConnectProviderGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const OpenidConnectProviderContract

OpenidConnectProviderContract: object

OpenId Connect Provider details.

clientId

clientId: string

Client ID of developer console which is the client application.

Optional clientSecret

clientSecret: undefined | string

Client Secret of developer console which is the client application.

Optional description

description: undefined | string

User-friendly description of OpenID Connect Provider.

displayName

displayName: string

User-friendly OpenID Connect Provider name.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

metadataEndpoint

metadataEndpoint: string

Metadata endpoint URI.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "OpenidConnectProviderContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "OpenidConnectProviderContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "properties.clientId"

type

type: object

name

name: "String" = "String"

clientSecret

clientSecret: object

serializedName

serializedName: string = "properties.clientSecret"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 50

type

type: object

name

name: "String" = "String"

metadataEndpoint

metadataEndpoint: object

required

required: true = true

serializedName

serializedName: string = "properties.metadataEndpoint"

type

type: object

name

name: "String" = "String"

Const OpenidConnectProviderUpdateContract

OpenidConnectProviderUpdateContract: object

Parameters supplied to the Update OpenID Connect Provider operation.

Optional clientId

clientId: undefined | string

Client ID of developer console which is the client application.

Optional clientSecret

clientSecret: undefined | string

Client Secret of developer console which is the client application.

Optional description

description: undefined | string

User-friendly description of OpenID Connect Provider.

Optional displayName

displayName: undefined | string

User-friendly OpenID Connect Provider name.

Optional metadataEndpoint

metadataEndpoint: undefined | string

Metadata endpoint URI.

serializedName

serializedName: string = "OpenidConnectProviderUpdateContract"

type

type: object

className

className: string = "OpenidConnectProviderUpdateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientId

clientId: object

serializedName

serializedName: string = "properties.clientId"

type

type: object

name

name: "String" = "String"

clientSecret

clientSecret: object

serializedName

serializedName: string = "properties.clientSecret"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 50

type

type: object

name

name: "String" = "String"

metadataEndpoint

metadataEndpoint: object

serializedName

serializedName: string = "properties.metadataEndpoint"

type

type: object

name

name: "String" = "String"

Const Operation

Operation: object

REST API operation

Optional display

display: OperationDisplay

The object that describes the operation.

Optional name

name: undefined | string

Operation name: {provider}/{resource}/{operation}

Optional origin

origin: undefined | string

The operation origin.

Optional properties

properties: any

The operation properties.

serializedName

serializedName: string = "Operation"

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Object" = "Object"

Const OperationCollection

OperationCollection: object
interface

Paged Operation list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "OperationCollection"

__@iterator

  • Iterator

    Returns IterableIterator<OperationContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<OperationContract>[]

      Additional items to add to the end of array1.

    Returns OperationContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns OperationContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, OperationContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: OperationContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: OperationContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): OperationContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns OperationContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): OperationContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns OperationContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: OperationContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: OperationContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: OperationContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: OperationContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: OperationContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns OperationContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns OperationContract

  • Parameters

    Returns OperationContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns OperationContract

  • Parameters

    Returns OperationContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns OperationContract[]

shift

  • Removes the first element from an array and returns it.

    Returns OperationContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns OperationContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns OperationContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: OperationContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns OperationContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<OperationContract>

type

type: object

className

className: string = "OperationCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationContract"

name

name: "Composite" = "Composite"

Const OperationContract

OperationContract: object

Api Operation details.

Optional description

description: undefined | string

Description of the operation. May include HTML formatting tags.

displayName

displayName: string

Operation Name.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

method

method: string

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional policies

policies: undefined | string

Operation Policies

Optional request

request: RequestContract

An entity containing request details.

Optional responses

responses: ResponseContract[]

Array of Operation responses.

Optional templateParameters

templateParameters: ParameterContract[]

Collection of URL template parameters.

urlTemplate

urlTemplate: string

Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}

serializedName

serializedName: string = "OperationContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "OperationContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

type

type: object

name

name: "String" = "String"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

method

method: object

required

required: true = true

serializedName

serializedName: string = "properties.method"

type

type: object

name

name: "String" = "String"

policies

policies: object

serializedName

serializedName: string = "properties.policies"

type

type: object

name

name: "String" = "String"

request

request: object

serializedName

serializedName: string = "properties.request"

type

type: object

className

className: string = "RequestContract"

name

name: "Composite" = "Composite"

responses

responses: object

serializedName

serializedName: string = "properties.responses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResponseContract"

name

name: "Composite" = "Composite"

templateParameters

templateParameters: object

serializedName

serializedName: string = "properties.templateParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParameterContract"

name

name: "Composite" = "Composite"

urlTemplate

urlTemplate: object

required

required: true = true

serializedName

serializedName: string = "properties.urlTemplate"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const OperationDisplay

OperationDisplay: object

The object that describes the operation.

Optional description

description: undefined | string

Friendly name of the operation

Optional operation

operation: undefined | string

Operation type: read, write, delete, listKeys/action, etc.

Optional provider

provider: undefined | string

Friendly name of the resource provider

Optional resource

resource: undefined | string

Resource type on which the operation is performed.

serializedName

serializedName: string = "Operation_display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationEntityBaseContract

OperationEntityBaseContract: object

Api Operation Entity Base Contract details.

Optional description

description: undefined | string

Description of the operation. May include HTML formatting tags.

Optional policies

policies: undefined | string

Operation Policies

Optional request

request: RequestContract

An entity containing request details.

Optional responses

responses: ResponseContract[]

Array of Operation responses.

Optional templateParameters

templateParameters: ParameterContract[]

Collection of URL template parameters.

serializedName

serializedName: string = "OperationEntityBaseContract"

type

type: object

className

className: string = "OperationEntityBaseContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

type

type: object

name

name: "String" = "String"

policies

policies: object

serializedName

serializedName: string = "policies"

type

type: object

name

name: "String" = "String"

request

request: object

serializedName

serializedName: string = "request"

type

type: object

className

className: string = "RequestContract"

name

name: "Composite" = "Composite"

responses

responses: object

serializedName

serializedName: string = "responses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResponseContract"

name

name: "Composite" = "Composite"

templateParameters

templateParameters: object

serializedName

serializedName: string = "templateParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParameterContract"

name

name: "Composite" = "Composite"

Const OperationListResult

OperationListResult: object
interface

Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "OperationListResult"

__@iterator

  • Iterator

    Returns IterableIterator<Operation>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Operation>[]

      Additional items to add to the end of array1.

    Returns Operation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Operation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Operation]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Operation]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Operation, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Operation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Operation[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Operation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Operation | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Operation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Operation, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Operation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Operation, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Operation, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Operation | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Operation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Operation
  • reduce(callbackfn: function, initialValue: Operation): Operation
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U

        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Operation
  • reduceRight(callbackfn: function, initialValue: Operation): Operation
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U

        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Operation[]

shift

  • Removes the first element from an array and returns it.

    Returns Operation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Operation[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Operation[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Operation[]
  • splice(start: number, deleteCount: number, ...items: Operation[]): Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Operation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Operation[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Operation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Operation>

type

type: object

className

className: string = "OperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const OperationResultContract

OperationResultContract: object

Operation Result.

Optional actionLog

actionLog: OperationResultLogItemContract[]

This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

error: ErrorResponseBody

Error Body Contract

Optional id

id: undefined | string

Operation result identifier.

Optional resultInfo

resultInfo: undefined | string

Optional result info.

Optional started

started: Date

Start time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional status

status: AsyncOperationStatus

Status of an async operation. Possible values include: 'Started', 'InProgress', 'Succeeded', 'Failed'

Optional updated

updated: Date

Last update time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

serializedName

serializedName: string = "OperationResultContract"

type

type: object

className

className: string = "OperationResultContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionLog

actionLog: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "actionLog"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationResultLogItemContract"

name

name: "Composite" = "Composite"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorResponseBody"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

resultInfo

resultInfo: object

serializedName

serializedName: string = "resultInfo"

type

type: object

name

name: "String" = "String"

started

started: object

serializedName

serializedName: string = "started"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Started","InProgress","Succeeded","Failed"]

name

name: "Enum" = "Enum"

updated

updated: object

serializedName

serializedName: string = "updated"

type

type: object

name

name: "DateTime" = "DateTime"

Const OperationResultLogItemContract

OperationResultLogItemContract: object

Log of the entity being created, updated or deleted.

Optional action

action: undefined | string

Action like create/update/delete.

Optional objectKey

objectKey: undefined | string

Identifier of the entity being created/updated/deleted.

Optional objectType

objectType: undefined | string

The type of entity contract.

serializedName

serializedName: string = "OperationResultLogItemContract"

type

type: object

className

className: string = "OperationResultLogItemContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "action"

type

type: object

name

name: "String" = "String"

objectKey

objectKey: object

serializedName

serializedName: string = "objectKey"

type

type: object

name

name: "String" = "String"

objectType

objectType: object

serializedName

serializedName: string = "objectType"

type

type: object

name

name: "String" = "String"

Const OperationTagResourceContractProperties

OperationTagResourceContractProperties: object

Operation Entity contract Properties.

Optional apiName

apiName: undefined | string

Api Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional apiRevision

apiRevision: undefined | string

Api Revision. NOTE: This property will not be serialized. It can only be populated by the server.

Optional apiVersion

apiVersion: undefined | string

Api Version. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

Operation Description. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Identifier of the operation in form /operations/{operationId}.

Optional method

method: undefined | string

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Operation name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional urlTemplate

urlTemplate: undefined | string

Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "OperationTagResourceContractProperties"

type

type: object

className

className: string = "OperationTagResourceContractProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiName

apiName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "apiName"

type

type: object

name

name: "String" = "String"

apiRevision

apiRevision: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "apiRevision"

type

type: object

name

name: "String" = "String"

apiVersion

apiVersion: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "apiVersion"

type

type: object

name

name: "String" = "String"

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

method

method: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "method"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

urlTemplate

urlTemplate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "urlTemplate"

type

type: object

name

name: "String" = "String"

Const OperationUpdateContract

OperationUpdateContract: object

Api Operation Update Contract details.

Optional description

description: undefined | string

Description of the operation. May include HTML formatting tags.

Optional displayName

displayName: undefined | string

Operation Name.

Optional method

method: undefined | string

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.

Optional policies

policies: undefined | string

Operation Policies

Optional request

request: RequestContract

An entity containing request details.

Optional responses

responses: ResponseContract[]

Array of Operation responses.

Optional templateParameters

templateParameters: ParameterContract[]

Collection of URL template parameters.

Optional urlTemplate

urlTemplate: undefined | string

Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}

serializedName

serializedName: string = "OperationUpdateContract"

type

type: object

className

className: string = "OperationUpdateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

method

method: object

serializedName

serializedName: string = "properties.method"

type

type: object

name

name: "String" = "String"

policies

policies: object

serializedName

serializedName: string = "properties.policies"

type

type: object

name

name: "String" = "String"

request

request: object

serializedName

serializedName: string = "properties.request"

type

type: object

className

className: string = "RequestContract"

name

name: "Composite" = "Composite"

responses

responses: object

serializedName

serializedName: string = "properties.responses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResponseContract"

name

name: "Composite" = "Composite"

templateParameters

templateParameters: object

serializedName

serializedName: string = "properties.templateParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParameterContract"

name

name: "Composite" = "Composite"

urlTemplate

urlTemplate: object

serializedName

serializedName: string = "properties.urlTemplate"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const ParameterContract

ParameterContract: object

Operation parameters details.

Optional defaultValue

defaultValue: undefined | string

Default parameter value.

Optional description

description: undefined | string

Parameter description.

name

name: string

Parameter name.

Optional required

required: undefined | false | true

Specifies whether parameter is required or not.

Optional values

values: string[]

Parameter values.

serializedName

serializedName: string = "ParameterContract"

type

type: object

Parameter type.

className

className: string = "ParameterContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultValue

defaultValue: object

serializedName

serializedName: string = "defaultValue"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

required

required: object

serializedName

serializedName: string = "required"

type

type: object

name

name: "Boolean" = "Boolean"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

values

values: object

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const PipelineDiagnosticSettings

PipelineDiagnosticSettings: object

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

Optional request

request: HttpMessageDiagnostic

Diagnostic settings for request.

Optional response

response: HttpMessageDiagnostic

Diagnostic settings for response.

serializedName

serializedName: string = "PipelineDiagnosticSettings"

type

type: object

className

className: string = "PipelineDiagnosticSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

request

request: object

serializedName

serializedName: string = "request"

type

type: object

className

className: string = "HttpMessageDiagnostic"

name

name: "Composite" = "Composite"

response

response: object

serializedName

serializedName: string = "response"

type

type: object

className

className: string = "HttpMessageDiagnostic"

name

name: "Composite" = "Composite"

Const PolicyCollection

PolicyCollection: object

The response of the list policy operation.

Optional nextLink

nextLink: undefined | string

Next page link if any.

Optional value

value: PolicyContract[]

Policy Contract value.

serializedName

serializedName: string = "PolicyCollection"

type

type: object

className

className: string = "PolicyCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PolicyContract"

name

name: "Composite" = "Composite"

Const PolicyContract

PolicyContract: object

Policy Contract details.

Optional format

format: PolicyContentFormat

Format of the policyContent. Possible values include: 'xml', 'xml-link', 'rawxml', 'rawxml-link'. Default value: 'xml'.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

value

value: string

Contents of the Policy as defined by the format.

serializedName

serializedName: string = "PolicyContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "PolicyContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

format

format: object

defaultValue

defaultValue: string = "xml"

serializedName

serializedName: string = "properties.format"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "properties.value"

type

type: object

name

name: "String" = "String"

Const PolicyCreateOrUpdateHeaders

PolicyCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "policy-createorupdate-headers"

type

type: object

className

className: string = "PolicyCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const PolicyGetEntityTagHeaders

PolicyGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "policy-getentitytag-headers"

type

type: object

className

className: string = "PolicyGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const PolicyGetHeaders

PolicyGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "policy-get-headers"

type

type: object

className

className: string = "PolicyGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const PolicySnippetContract

PolicySnippetContract: object

Policy snippet.

Optional content

content: undefined | string

Snippet content. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Snippet name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scope

scope: undefined | number

Binary OR value of the Snippet scope. NOTE: This property will not be serialized. It can only be populated by the server.

Optional toolTip

toolTip: undefined | string

Snippet toolTip. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PolicySnippetContract"

type

type: object

className

className: string = "PolicySnippetContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

content

content: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "content"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

scope

scope: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "scope"

type

type: object

name

name: "Number" = "Number"

toolTip

toolTip: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "toolTip"

type

type: object

name

name: "String" = "String"

Const PolicySnippetsCollection

PolicySnippetsCollection: object

The response of the list policy snippets operation.

Optional value

value: PolicySnippetContract[]

Policy snippet value.

serializedName

serializedName: string = "PolicySnippetsCollection"

type

type: object

className

className: string = "PolicySnippetsCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PolicySnippetContract"

name

name: "Composite" = "Composite"

Const PortalDelegationSettings

PortalDelegationSettings: object

Delegation settings for a developer portal.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscriptions

subscriptions: SubscriptionsDelegationSettingsProperties

Subscriptions delegation settings.

Optional url

url: undefined | string

A delegation Url.

Optional userRegistration

userRegistration: RegistrationDelegationSettingsProperties

User registration delegation settings.

Optional validationKey

validationKey: undefined | string

A base64-encoded validation key to validate, that a request is coming from Azure API Management.

serializedName

serializedName: string = "PortalDelegationSettings"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "PortalDelegationSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

subscriptions

subscriptions: object

serializedName

serializedName: string = "properties.subscriptions"

type

type: object

className

className: string = "SubscriptionsDelegationSettingsProperties"

name

name: "Composite" = "Composite"

url

url: object

serializedName

serializedName: string = "properties.url"

type

type: object

name

name: "String" = "String"

userRegistration

userRegistration: object

serializedName

serializedName: string = "properties.userRegistration"

type

type: object

className

className: string = "RegistrationDelegationSettingsProperties"

name

name: "Composite" = "Composite"

validationKey

validationKey: object

serializedName

serializedName: string = "properties.validationKey"

type

type: object

name

name: "String" = "String"

Const PortalSigninSettings

PortalSigninSettings: object

Sign-In settings for the Developer Portal.

Optional enabled

enabled: undefined | false | true

Redirect Anonymous users to the Sign-In page.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PortalSigninSettings"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "PortalSigninSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const PortalSignupSettings

PortalSignupSettings: object

Sign-Up settings for a developer portal.

Optional enabled

enabled: undefined | false | true

Allow users to sign up on a developer portal.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional termsOfService

termsOfService: TermsOfServiceProperties

Terms of service contract properties.

serializedName

serializedName: string = "PortalSignupSettings"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "PortalSignupSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

termsOfService

termsOfService: object

serializedName

serializedName: string = "properties.termsOfService"

type

type: object

className

className: string = "TermsOfServiceProperties"

name

name: "Composite" = "Composite"

Const ProductCollection

ProductCollection: object
interface

Paged Products list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "ProductCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ProductContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProductContract>[]

      Additional items to add to the end of array1.

    Returns ProductContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProductContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProductContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProductContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProductContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProductContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProductContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProductContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ProductContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProductContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProductContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProductContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProductContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProductContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProductContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ProductContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ProductContract

  • Parameters

    Returns ProductContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ProductContract

  • Parameters

    Returns ProductContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ProductContract[]

shift

  • Removes the first element from an array and returns it.

    Returns ProductContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProductContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProductContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProductContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProductContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProductContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProductContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ProductContract>

type

type: object

className

className: string = "ProductCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProductContract"

name

name: "Composite" = "Composite"

Const ProductContract

ProductContract: object

Product details.

Optional approvalRequired

approvalRequired: undefined | false | true

whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.

Optional description

description: undefined | string

Product description. May include HTML formatting tags.

displayName

displayName: string

Product name.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: ProductState

whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'notPublished', 'published'

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.

Optional subscriptionsLimit

subscriptionsLimit: undefined | number

Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.

Optional terms

terms: undefined | string

Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.

serializedName

serializedName: string = "ProductContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProductContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

approvalRequired

approvalRequired: object

serializedName

serializedName: string = "properties.approvalRequired"

type

type: object

name

name: "Boolean" = "Boolean"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["notPublished","published"]

name

name: "Enum" = "Enum"

subscriptionRequired

subscriptionRequired: object

serializedName

serializedName: string = "properties.subscriptionRequired"

type

type: object

name

name: "Boolean" = "Boolean"

subscriptionsLimit

subscriptionsLimit: object

serializedName

serializedName: string = "properties.subscriptionsLimit"

type

type: object

name

name: "Number" = "Number"

terms

terms: object

serializedName

serializedName: string = "properties.terms"

type

type: object

name

name: "String" = "String"

Const ProductCreateOrUpdateHeaders

ProductCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "product-createorupdate-headers"

type

type: object

className

className: string = "ProductCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ProductEntityBaseParameters

ProductEntityBaseParameters: object

Product Entity Base Parameters

Optional approvalRequired

approvalRequired: undefined | false | true

whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.

Optional description

description: undefined | string

Product description. May include HTML formatting tags.

Optional state

state: ProductState

whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'notPublished', 'published'

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.

Optional subscriptionsLimit

subscriptionsLimit: undefined | number

Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.

Optional terms

terms: undefined | string

Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.

serializedName

serializedName: string = "ProductEntityBaseParameters"

type

type: object

className

className: string = "ProductEntityBaseParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

approvalRequired

approvalRequired: object

serializedName

serializedName: string = "approvalRequired"

type

type: object

name

name: "Boolean" = "Boolean"

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["notPublished","published"]

name

name: "Enum" = "Enum"

subscriptionRequired

subscriptionRequired: object

serializedName

serializedName: string = "subscriptionRequired"

type

type: object

name

name: "Boolean" = "Boolean"

subscriptionsLimit

subscriptionsLimit: object

serializedName

serializedName: string = "subscriptionsLimit"

type

type: object

name

name: "Number" = "Number"

terms

terms: object

serializedName

serializedName: string = "terms"

type

type: object

name

name: "String" = "String"

Const ProductGetEntityTagHeaders

ProductGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "product-getentitytag-headers"

type

type: object

className

className: string = "ProductGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ProductGetHeaders

ProductGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "product-get-headers"

type

type: object

className

className: string = "ProductGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ProductPolicyCreateOrUpdateHeaders

ProductPolicyCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "productpolicy-createorupdate-headers"

type

type: object

className

className: string = "ProductPolicyCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ProductPolicyGetEntityTagHeaders

ProductPolicyGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "productpolicy-getentitytag-headers"

type

type: object

className

className: string = "ProductPolicyGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ProductPolicyGetHeaders

ProductPolicyGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "productpolicy-get-headers"

type

type: object

className

className: string = "ProductPolicyGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const ProductTagResourceContractProperties

ProductTagResourceContractProperties: object

Product profile.

Optional approvalRequired

approvalRequired: undefined | false | true

whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.

Optional description

description: undefined | string

Product description. May include HTML formatting tags.

Optional id

id: undefined | string

Identifier of the product in the form of /products/{productId}

name

name: string

Product name.

Optional state

state: ProductState

whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'notPublished', 'published'

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.

Optional subscriptionsLimit

subscriptionsLimit: undefined | number

Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.

Optional terms

terms: undefined | string

Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.

serializedName

serializedName: string = "ProductTagResourceContractProperties"

type

type: object

className

className: string = "ProductTagResourceContractProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const ProductUpdateParameters

ProductUpdateParameters: object

Product Update parameters.

Optional approvalRequired

approvalRequired: undefined | false | true

whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.

Optional description

description: undefined | string

Product description. May include HTML formatting tags.

Optional displayName

displayName: undefined | string

Product name.

Optional state

state: ProductState

whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'notPublished', 'published'

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.

Optional subscriptionsLimit

subscriptionsLimit: undefined | number

Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.

Optional terms

terms: undefined | string

Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.

serializedName

serializedName: string = "ProductUpdateParameters"

type

type: object

className

className: string = "ProductUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

approvalRequired

approvalRequired: object

serializedName

serializedName: string = "properties.approvalRequired"

type

type: object

name

name: "Boolean" = "Boolean"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 1000

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 300

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["notPublished","published"]

name

name: "Enum" = "Enum"

subscriptionRequired

subscriptionRequired: object

serializedName

serializedName: string = "properties.subscriptionRequired"

type

type: object

name

name: "Boolean" = "Boolean"

subscriptionsLimit

subscriptionsLimit: object

serializedName

serializedName: string = "properties.subscriptionsLimit"

type

type: object

name

name: "Number" = "Number"

terms

terms: object

serializedName

serializedName: string = "properties.terms"

type

type: object

name

name: "String" = "String"

Const PropertyCollection

PropertyCollection: object
interface

Paged Property list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "PropertyCollection"

__@iterator

  • Iterator

    Returns IterableIterator<PropertyContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PropertyContract>[]

      Additional items to add to the end of array1.

    Returns PropertyContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PropertyContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PropertyContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PropertyContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PropertyContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PropertyContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PropertyContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PropertyContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns PropertyContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PropertyContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PropertyContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PropertyContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PropertyContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PropertyContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PropertyContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns PropertyContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns PropertyContract

  • Parameters

    Returns PropertyContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns PropertyContract

  • Parameters

    Returns PropertyContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns PropertyContract[]

shift

  • Removes the first element from an array and returns it.

    Returns PropertyContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PropertyContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PropertyContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PropertyContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PropertyContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns PropertyContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PropertyContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<PropertyContract>

type

type: object

className

className: string = "PropertyCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PropertyContract"

name

name: "Composite" = "Composite"

Const PropertyContract

PropertyContract: object

Property details.

displayName

displayName: string

Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional secret

secret: undefined | false | true

Determines whether the value is a secret and should be encrypted or not. Default value is false.

Optional tags

tags: string[]

Optional tags that when provided can be used to filter the property list.

value

value: string

Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.

serializedName

serializedName: string = "PropertyContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "PropertyContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9-._]+$/

type

type: object

name

name: "String" = "String"

secret

secret: object

serializedName

serializedName: string = "properties.secret"

type

type: object

name

name: "Boolean" = "Boolean"

tags

tags: object

serializedName

serializedName: string = "properties.tags"

constraints

constraints: object

MaxItems

MaxItems: number = 32

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "properties.value"

constraints

constraints: object

MaxLength

MaxLength: number = 4096

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const PropertyCreateOrUpdateHeaders

PropertyCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "property-createorupdate-headers"

type

type: object

className

className: string = "PropertyCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const PropertyEntityBaseParameters

PropertyEntityBaseParameters: object

Property Entity Base Parameters set.

Optional secret

secret: undefined | false | true

Determines whether the value is a secret and should be encrypted or not. Default value is false.

Optional tags

tags: string[]

Optional tags that when provided can be used to filter the property list.

serializedName

serializedName: string = "PropertyEntityBaseParameters"

type

type: object

className

className: string = "PropertyEntityBaseParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

secret

secret: object

serializedName

serializedName: string = "secret"

type

type: object

name

name: "Boolean" = "Boolean"

tags

tags: object

serializedName

serializedName: string = "tags"

constraints

constraints: object

MaxItems

MaxItems: number = 32

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const PropertyGetEntityTagHeaders

PropertyGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "property-getentitytag-headers"

type

type: object

className

className: string = "PropertyGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const PropertyGetHeaders

PropertyGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "property-get-headers"

type

type: object

className

className: string = "PropertyGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const PropertyUpdateParameters

PropertyUpdateParameters: object

Property update Parameters.

Optional displayName

displayName: undefined | string

Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.

Optional secret

secret: undefined | false | true

Determines whether the value is a secret and should be encrypted or not. Default value is false.

Optional tags

tags: string[]

Optional tags that when provided can be used to filter the property list.

Optional value

value: undefined | string

Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.

serializedName

serializedName: string = "PropertyUpdateParameters"

type

type: object

className

className: string = "PropertyUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9-._]+$/

type

type: object

name

name: "String" = "String"

secret

secret: object

serializedName

serializedName: string = "properties.secret"

type

type: object

name

name: "Boolean" = "Boolean"

tags

tags: object

serializedName

serializedName: string = "properties.tags"

constraints

constraints: object

MaxItems

MaxItems: number = 32

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "properties.value"

constraints

constraints: object

MaxLength

MaxLength: number = 4096

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const QuotaCounterCollection

QuotaCounterCollection: object

Paged Quota Counter list representation.

Optional count

count: undefined | number

Total record count number across all pages.

Optional nextLink

nextLink: undefined | string

Next page link if any.

Optional value

value: QuotaCounterContract[]

Quota counter values.

serializedName

serializedName: string = "QuotaCounterCollection"

type

type: object

className

className: string = "QuotaCounterCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "QuotaCounterContract"

name

name: "Composite" = "Composite"

Const QuotaCounterContract

QuotaCounterContract: object

Quota counter details.

counterKey

counterKey: string

The Key value of the Counter. Must not be empty.

periodEndTime

periodEndTime: Date

The date of the end of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

periodKey

periodKey: string

Identifier of the Period for which the counter was collected. Must not be empty.

periodStartTime

periodStartTime: Date

The date of the start of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional value

value: QuotaCounterValueContractProperties

Quota Value Properties

serializedName

serializedName: string = "QuotaCounterContract"

type

type: object

className

className: string = "QuotaCounterContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

counterKey

counterKey: object

required

required: true = true

serializedName

serializedName: string = "counterKey"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

periodEndTime

periodEndTime: object

required

required: true = true

serializedName

serializedName: string = "periodEndTime"

type

type: object

name

name: "DateTime" = "DateTime"

periodKey

periodKey: object

required

required: true = true

serializedName

serializedName: string = "periodKey"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

periodStartTime

periodStartTime: object

required

required: true = true

serializedName

serializedName: string = "periodStartTime"

type

type: object

name

name: "DateTime" = "DateTime"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

className

className: string = "QuotaCounterValueContractProperties"

name

name: "Composite" = "Composite"

Const QuotaCounterValueContract

QuotaCounterValueContract: object

Quota counter value details.

Optional callsCount

callsCount: undefined | number

Number of times Counter was called.

Optional kbTransferred

kbTransferred: undefined | number

Data Transferred in KiloBytes.

serializedName

serializedName: string = "QuotaCounterValueContract"

type

type: object

className

className: string = "QuotaCounterValueContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

callsCount

callsCount: object

serializedName

serializedName: string = "value.callsCount"

type

type: object

name

name: "Number" = "Number"

kbTransferred

kbTransferred: object

serializedName

serializedName: string = "value.kbTransferred"

type

type: object

name

name: "Number" = "Number"

Const QuotaCounterValueContractProperties

QuotaCounterValueContractProperties: object

Quota counter value details.

Optional callsCount

callsCount: undefined | number

Number of times Counter was called.

Optional kbTransferred

kbTransferred: undefined | number

Data Transferred in KiloBytes.

serializedName

serializedName: string = "QuotaCounterValueContractProperties"

type

type: object

className

className: string = "QuotaCounterValueContractProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

callsCount

callsCount: object

serializedName

serializedName: string = "callsCount"

type

type: object

name

name: "Number" = "Number"

kbTransferred

kbTransferred: object

serializedName

serializedName: string = "kbTransferred"

type

type: object

name

name: "Number" = "Number"

Const RecipientEmailCollection

RecipientEmailCollection: object

Paged Recipient User list representation.

Optional nextLink

nextLink: undefined | string

Next page link if any.

Optional value

value: RecipientEmailContract[]

Page values.

serializedName

serializedName: string = "RecipientEmailCollection"

type

type: object

className

className: string = "RecipientEmailCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecipientEmailContract"

name

name: "Composite" = "Composite"

Const RecipientEmailContract

RecipientEmailContract: object

Recipient Email details.

Optional email

email: undefined | string

User Email subscribed to notification.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RecipientEmailContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RecipientEmailContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

email

email: object

serializedName

serializedName: string = "properties.email"

type

type: object

name

name: "String" = "String"

Const RecipientUserCollection

RecipientUserCollection: object

Paged Recipient User list representation.

Optional nextLink

nextLink: undefined | string

Next page link if any.

Optional value

value: RecipientUserContract[]

Page values.

serializedName

serializedName: string = "RecipientUserCollection"

type

type: object

className

className: string = "RecipientUserCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecipientUserContract"

name

name: "Composite" = "Composite"

Const RecipientUserContract

RecipientUserContract: object

Recipient User details.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional userId

userId: undefined | string

API Management UserId subscribed to notification.

serializedName

serializedName: string = "RecipientUserContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RecipientUserContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

userId

userId: object

serializedName

serializedName: string = "properties.userId"

type

type: object

name

name: "String" = "String"

Const RecipientsContractProperties

RecipientsContractProperties: object

Notification Parameter contract.

Optional emails

emails: string[]

List of Emails subscribed for the notification.

Optional users

users: string[]

List of Users subscribed for the notification.

serializedName

serializedName: string = "RecipientsContractProperties"

type

type: object

className

className: string = "RecipientsContractProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

emails

emails: object

serializedName

serializedName: string = "emails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

users

users: object

serializedName

serializedName: string = "users"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const RegionContract

RegionContract: object

Region profile.

Optional isDeleted

isDeleted: undefined | false | true

whether Region is deleted.

Optional isMasterRegion

isMasterRegion: undefined | false | true

whether Region is the master region.

Optional name

name: undefined | string

Region name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RegionContract"

type

type: object

className

className: string = "RegionContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isDeleted

isDeleted: object

serializedName

serializedName: string = "isDeleted"

type

type: object

name

name: "Boolean" = "Boolean"

isMasterRegion

isMasterRegion: object

serializedName

serializedName: string = "isMasterRegion"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const RegionListResult

RegionListResult: object
interface

Lists Regions operation response details.

extends

Array

Array

Array: ArrayConstructor

Optional count

count: undefined | number

Total record count number across all pages.

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "RegionListResult"

__@iterator

  • Iterator

    Returns IterableIterator<RegionContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RegionContract>[]

      Additional items to add to the end of array1.

    Returns RegionContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RegionContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RegionContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RegionContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RegionContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RegionContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RegionContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RegionContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns RegionContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RegionContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RegionContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RegionContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RegionContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RegionContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RegionContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RegionContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RegionContract

  • Parameters

    Returns RegionContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RegionContract

  • Parameters

    Returns RegionContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns RegionContract[]

shift

  • Removes the first element from an array and returns it.

    Returns RegionContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RegionContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RegionContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RegionContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RegionContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns RegionContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RegionContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RegionContract>

type

type: object

className

className: string = "RegionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RegionContract"

name

name: "Composite" = "Composite"

Const RegistrationDelegationSettingsProperties

RegistrationDelegationSettingsProperties: object

User registration delegation settings properties.

Optional enabled

enabled: undefined | false | true

Enable or disable delegation for user registration.

serializedName

serializedName: string = "RegistrationDelegationSettingsProperties"

type

type: object

className

className: string = "RegistrationDelegationSettingsProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const ReportCollection

ReportCollection: object
interface

Paged Report records list representation.

extends

Array

Array

Array: ArrayConstructor

Optional count

count: undefined | number

Total record count number across all pages.

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "ReportCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ReportRecordContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns ReportRecordContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ReportRecordContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ReportRecordContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ReportRecordContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ReportRecordContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ReportRecordContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ReportRecordContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ReportRecordContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ReportRecordContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ReportRecordContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ReportRecordContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ReportRecordContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ReportRecordContract

  • Parameters

    Returns ReportRecordContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ReportRecordContract

  • Parameters

    Returns ReportRecordContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ReportRecordContract[]

shift

  • Removes the first element from an array and returns it.

    Returns ReportRecordContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ReportRecordContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ReportRecordContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ReportRecordContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns ReportRecordContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ReportRecordContract>

type

type: object

className

className: string = "ReportCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ReportRecordContract"

name

name: "Composite" = "Composite"

Const ReportRecordContract

ReportRecordContract: object

Report data.

Optional apiId

apiId: undefined | string

API identifier path. /apis/{apiId}

Optional apiRegion

apiRegion: undefined | string

API region identifier.

Optional apiTimeAvg

apiTimeAvg: undefined | number

Average time it took to process request.

Optional apiTimeMax

apiTimeMax: undefined | number

Maximum time it took to process request.

Optional apiTimeMin

apiTimeMin: undefined | number

Minimum time it took to process request.

Optional bandwidth

bandwidth: undefined | number

Bandwidth consumed.

Optional cacheHitCount

cacheHitCount: undefined | number

Number of times when content was served from cache policy.

Optional cacheMissCount

cacheMissCount: undefined | number

Number of times content was fetched from backend.

Optional callCountBlocked

callCountBlocked: undefined | number

Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests

Optional callCountFailed

callCountFailed: undefined | number

Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600

Optional callCountOther

callCountOther: undefined | number

Number of other calls.

Optional callCountSuccess

callCountSuccess: undefined | number

Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect

Optional callCountTotal

callCountTotal: undefined | number

Total number of calls.

Optional country

country: undefined | string

Country to which this record data is related.

Optional interval

interval: undefined | string

Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).

Optional name

name: undefined | string

Name depending on report endpoint specifies product, API, operation or developer name.

Optional operationId

operationId: undefined | string

Operation identifier path. /apis/{apiId}/operations/{operationId}

Optional productId

productId: undefined | string

Product identifier path. /products/{productId} NOTE: This property will not be serialized. It can only be populated by the server.

Optional region

region: undefined | string

Country region to which this record data is related.

Optional serviceTimeAvg

serviceTimeAvg: undefined | number

Average time it took to process request on backend.

Optional serviceTimeMax

serviceTimeMax: undefined | number

Maximum time it took to process request on backend.

Optional serviceTimeMin

serviceTimeMin: undefined | number

Minimum time it took to process request on backend.

Optional subscriptionId

subscriptionId: undefined | string

Subscription identifier path. /subscriptions/{subscriptionId}

Optional timestamp

timestamp: Date

Start of aggregation period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional userId

userId: undefined | string

User identifier path. /users/{userId} NOTE: This property will not be serialized. It can only be populated by the server.

Optional zip

zip: undefined | string

Zip code to which this record data is related.

serializedName

serializedName: string = "ReportRecordContract"

type

type: object

className

className: string = "ReportRecordContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiId

apiId: object

serializedName

serializedName: string = "apiId"

type

type: object

name

name: "String" = "String"

apiRegion

apiRegion: object

serializedName

serializedName: string = "apiRegion"

type

type: object

name

name: "String" = "String"

apiTimeAvg

apiTimeAvg: object

serializedName

serializedName: string = "apiTimeAvg"

type

type: object

name

name: "Number" = "Number"

apiTimeMax

apiTimeMax: object

serializedName

serializedName: string = "apiTimeMax"

type

type: object

name

name: "Number" = "Number"

apiTimeMin

apiTimeMin: object

serializedName

serializedName: string = "apiTimeMin"

type

type: object

name

name: "Number" = "Number"

bandwidth

bandwidth: object

serializedName

serializedName: string = "bandwidth"

type

type: object

name

name: "Number" = "Number"

cacheHitCount

cacheHitCount: object

serializedName

serializedName: string = "cacheHitCount"

type

type: object

name

name: "Number" = "Number"

cacheMissCount

cacheMissCount: object

serializedName

serializedName: string = "cacheMissCount"

type

type: object

name

name: "Number" = "Number"

callCountBlocked

callCountBlocked: object

serializedName

serializedName: string = "callCountBlocked"

type

type: object

name

name: "Number" = "Number"

callCountFailed

callCountFailed: object

serializedName

serializedName: string = "callCountFailed"

type

type: object

name

name: "Number" = "Number"

callCountOther

callCountOther: object

serializedName

serializedName: string = "callCountOther"

type

type: object

name

name: "Number" = "Number"

callCountSuccess

callCountSuccess: object

serializedName

serializedName: string = "callCountSuccess"

type

type: object

name

name: "Number" = "Number"

callCountTotal

callCountTotal: object

serializedName

serializedName: string = "callCountTotal"

type

type: object

name

name: "Number" = "Number"

country

country: object

serializedName

serializedName: string = "country"

type

type: object

name

name: "String" = "String"

interval

interval: object

serializedName

serializedName: string = "interval"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

operationId

operationId: object

serializedName

serializedName: string = "operationId"

type

type: object

name

name: "String" = "String"

productId

productId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "productId"

type

type: object

name

name: "String" = "String"

region

region: object

serializedName

serializedName: string = "region"

type

type: object

name

name: "String" = "String"

serviceTimeAvg

serviceTimeAvg: object

serializedName

serializedName: string = "serviceTimeAvg"

type

type: object

name

name: "Number" = "Number"

serviceTimeMax

serviceTimeMax: object

serializedName

serializedName: string = "serviceTimeMax"

type

type: object

name

name: "Number" = "Number"

serviceTimeMin

serviceTimeMin: object

serializedName

serializedName: string = "serviceTimeMin"

type

type: object

name

name: "Number" = "Number"

subscriptionId

subscriptionId: object

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

timestamp

timestamp: object

serializedName

serializedName: string = "timestamp"

type

type: object

name

name: "DateTime" = "DateTime"

userId

userId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "userId"

type

type: object

name

name: "String" = "String"

zip

zip: object

serializedName

serializedName: string = "zip"

type

type: object

name

name: "String" = "String"

Const RepresentationContract

RepresentationContract: object

Operation request/response representation details.

contentType

contentType: string

Specifies a registered or custom content type for this representation, e.g. application/xml.

Optional formParameters

formParameters: ParameterContract[]

Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..

Optional sample

sample: undefined | string

An example of the representation.

Optional schemaId

schemaId: undefined | string

Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.

Optional typeName

typeName: undefined | string

Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.

serializedName

serializedName: string = "RepresentationContract"

type

type: object

className

className: string = "RepresentationContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentType

contentType: object

required

required: true = true

serializedName

serializedName: string = "contentType"

type

type: object

name

name: "String" = "String"

formParameters

formParameters: object

serializedName

serializedName: string = "formParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParameterContract"

name

name: "Composite" = "Composite"

sample

sample: object

serializedName

serializedName: string = "sample"

type

type: object

name

name: "String" = "String"

schemaId

schemaId: object

serializedName

serializedName: string = "schemaId"

type

type: object

name

name: "String" = "String"

typeName

typeName: object

serializedName

serializedName: string = "typeName"

type

type: object

name

name: "String" = "String"

Const RequestContract

RequestContract: object

Operation request details.

Optional description

description: undefined | string

Operation request description.

Optional headers

headers: ParameterContract[]

Collection of operation request headers.

Optional queryParameters

queryParameters: ParameterContract[]

Collection of operation request query parameters.

Optional representations

representations: RepresentationContract[]

Collection of operation request representations.

serializedName

serializedName: string = "RequestContract"

type

type: object

className

className: string = "RequestContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

headers

headers: object

serializedName

serializedName: string = "headers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParameterContract"

name

name: "Composite" = "Composite"

queryParameters

queryParameters: object

serializedName

serializedName: string = "queryParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParameterContract"

name

name: "Composite" = "Composite"

representations

representations: object

serializedName

serializedName: string = "representations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RepresentationContract"

name

name: "Composite" = "Composite"

Const RequestReportCollection

RequestReportCollection: object
interface

Paged Report records list representation.

extends

Array

Array

Array: ArrayConstructor

Optional count

count: undefined | number

Total record count number across all pages.

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "RequestReportCollection"

__@iterator

  • Iterator

    Returns IterableIterator<RequestReportRecordContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns RequestReportRecordContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RequestReportRecordContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RequestReportRecordContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RequestReportRecordContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns RequestReportRecordContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RequestReportRecordContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns RequestReportRecordContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RequestReportRecordContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RequestReportRecordContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RequestReportRecordContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RequestReportRecordContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns RequestReportRecordContract[]

shift

  • Removes the first element from an array and returns it.

    Returns RequestReportRecordContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RequestReportRecordContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RequestReportRecordContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RequestReportRecordContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns RequestReportRecordContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RequestReportRecordContract>

type

type: object

className

className: string = "RequestReportCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RequestReportRecordContract"

name

name: "Composite" = "Composite"

Const RequestReportRecordContract

RequestReportRecordContract: object

Request Report data.

Optional apiId

apiId: undefined | string

API identifier path. /apis/{apiId}

Optional apiRegion

apiRegion: undefined | string

Azure region where the gateway that processed this request is located.

Optional apiTime

apiTime: undefined | number

The total time it took to process this request.

Optional backendResponseCode

backendResponseCode: undefined | string

The HTTP status code received by the gateway as a result of forwarding this request to the backend.

Optional cache

cache: undefined | string

Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend.

Optional ipAddress

ipAddress: undefined | string

The client IP address associated with this request.

Optional method

method: undefined | string

The HTTP method associated with this request..

Optional operationId

operationId: undefined | string

Operation identifier path. /apis/{apiId}/operations/{operationId}

Optional productId

productId: undefined | string

Product identifier path. /products/{productId} NOTE: This property will not be serialized. It can only be populated by the server.

Optional requestId

requestId: undefined | string

Request Identifier.

Optional requestSize

requestSize: undefined | number

The size of this request..

Optional responseCode

responseCode: undefined | number

The HTTP status code returned by the gateway.

Optional responseSize

responseSize: undefined | number

The size of the response returned by the gateway.

Optional serviceTime

serviceTime: undefined | number

he time it took to forward this request to the backend and get the response back.

Optional subscriptionId

subscriptionId: undefined | string

Subscription identifier path. /subscriptions/{subscriptionId}

Optional timestamp

timestamp: Date

The date and time when this request was received by the gateway in ISO 8601 format.

Optional url

url: undefined | string

The full URL associated with this request.

Optional userId

userId: undefined | string

User identifier path. /users/{userId} NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RequestReportRecordContract"

type

type: object

className

className: string = "RequestReportRecordContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiId

apiId: object

serializedName

serializedName: string = "apiId"

type

type: object

name

name: "String" = "String"

apiRegion

apiRegion: object

serializedName

serializedName: string = "apiRegion"

type

type: object

name

name: "String" = "String"

apiTime

apiTime: object

serializedName

serializedName: string = "apiTime"

type

type: object

name

name: "Number" = "Number"

backendResponseCode

backendResponseCode: object

serializedName

serializedName: string = "backendResponseCode"

type

type: object

name

name: "String" = "String"

cache

cache: object

serializedName

serializedName: string = "cache"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

method

method: object

serializedName

serializedName: string = "method"

type

type: object

name

name: "String" = "String"

operationId

operationId: object

serializedName

serializedName: string = "operationId"

type

type: object

name

name: "String" = "String"

productId

productId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "productId"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "requestId"

type

type: object

name

name: "String" = "String"

requestSize

requestSize: object

serializedName

serializedName: string = "requestSize"

type

type: object

name

name: "Number" = "Number"

responseCode

responseCode: object

serializedName

serializedName: string = "responseCode"

type

type: object

name

name: "Number" = "Number"

responseSize

responseSize: object

serializedName

serializedName: string = "responseSize"

type

type: object

name

name: "Number" = "Number"

serviceTime

serviceTime: object

serializedName

serializedName: string = "serviceTime"

type

type: object

name

name: "Number" = "Number"

subscriptionId

subscriptionId: object

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

timestamp

timestamp: object

serializedName

serializedName: string = "timestamp"

type

type: object

name

name: "DateTime" = "DateTime"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

userId

userId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "userId"

type

type: object

name

name: "String" = "String"

Const Resource

Resource: object

The Resource definition.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceSku

ResourceSku: object

Describes an available API Management SKU.

Optional name

name: SkuType

Name of the Sku. Possible values include: 'Developer', 'Standard', 'Premium', 'Basic', 'Consumption'

serializedName

serializedName: string = "ResourceSku"

type

type: object

className

className: string = "ResourceSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ResourceSkuCapacity

ResourceSkuCapacity: object

Describes scaling information of a SKU.

Optional default

default: undefined | number

The default capacity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maximum

maximum: undefined | number

The maximum capacity that can be set. NOTE: This property will not be serialized. It can only be populated by the server.

Optional minimum

minimum: undefined | number

The minimum capacity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scaleType

scaleType: ResourceSkuCapacityScaleType

The scale type applicable to the sku. Possible values include: 'automatic', 'manual', 'none' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceSkuCapacity"

type

type: object

className

className: string = "ResourceSkuCapacity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

default

default: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "default"

type

type: object

name

name: "Number" = "Number"

maximum

maximum: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maximum"

type

type: object

name

name: "Number" = "Number"

minimum

minimum: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "minimum"

type

type: object

name

name: "Number" = "Number"

scaleType

scaleType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "scaleType"

type

type: object

name

name: "String" = "String"

Const ResourceSkuResult

ResourceSkuResult: object

Describes an available API Management service SKU.

Optional capacity

capacity: ResourceSkuCapacity

Specifies the number of API Management units. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceType

resourceType: undefined | string

The type of resource the SKU applies to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sku

sku: ResourceSku

Specifies API Management SKU. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceSkuResult"

type

type: object

className

className: string = "ResourceSkuResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "capacity"

type

type: object

className

className: string = "ResourceSkuCapacity"

name

name: "Composite" = "Composite"

resourceType

resourceType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceType"

type

type: object

name

name: "String" = "String"

sku

sku: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "ResourceSku"

name

name: "Composite" = "Composite"

Const ResourceSkuResults

ResourceSkuResults: object
interface

The API Management service SKUs operation response.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The uri to fetch the next page of API Management service Skus.

serializedName

serializedName: string = "ResourceSkuResults"

__@iterator

  • Iterator

    Returns IterableIterator<ResourceSkuResult>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ResourceSkuResult>[]

      Additional items to add to the end of array1.

    Returns ResourceSkuResult[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ResourceSkuResult[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ResourceSkuResult]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ResourceSkuResult, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ResourceSkuResult

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ResourceSkuResult[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ResourceSkuResult[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ResourceSkuResult | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ResourceSkuResult | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ResourceSkuResult, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ResourceSkuResult

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ResourceSkuResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ResourceSkuResult, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ResourceSkuResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ResourceSkuResult | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ResourceSkuResult

  • Parameters

    Returns ResourceSkuResult

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ResourceSkuResult

  • Parameters

    Returns ResourceSkuResult

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ResourceSkuResult[]

shift

  • Removes the first element from an array and returns it.

    Returns ResourceSkuResult | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ResourceSkuResult[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ResourceSkuResult[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ResourceSkuResult[]

      Elements to insert into the array in place of the deleted elements.

    Returns ResourceSkuResult[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ResourceSkuResult>

type

type: object

className

className: string = "ResourceSkuResults"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceSkuResult"

name

name: "Composite" = "Composite"

Const ResponseContract

ResponseContract: object

Operation response details.

Optional description

description: undefined | string

Operation response description.

Optional headers

headers: ParameterContract[]

Collection of operation response headers.

Optional representations

representations: RepresentationContract[]

Collection of operation response representations.

statusCode

statusCode: number

Operation response HTTP status code.

serializedName

serializedName: string = "ResponseContract"

type

type: object

className

className: string = "ResponseContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

headers

headers: object

serializedName

serializedName: string = "headers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParameterContract"

name

name: "Composite" = "Composite"

representations

representations: object

serializedName

serializedName: string = "representations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RepresentationContract"

name

name: "Composite" = "Composite"

statusCode

statusCode: object

required

required: true = true

serializedName

serializedName: string = "statusCode"

type

type: object

name

name: "Number" = "Number"

Const SamplingSettings

SamplingSettings: object

Sampling settings for Diagnostic.

Optional percentage

percentage: undefined | number

Rate of sampling for fixed-rate sampling.

Optional samplingType

samplingType: SamplingType

Sampling type. Possible values include: 'fixed'

serializedName

serializedName: string = "SamplingSettings"

type

type: object

className

className: string = "SamplingSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

percentage

percentage: object

serializedName

serializedName: string = "percentage"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

samplingType

samplingType: object

serializedName

serializedName: string = "samplingType"

type

type: object

name

name: "String" = "String"

Const SaveConfigurationParameter

SaveConfigurationParameter: object

Save Tenant Configuration Contract details.

branch

branch: string

The name of the Git branch in which to commit the current configuration snapshot.

Optional force

force: undefined | false | true

The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten.

serializedName

serializedName: string = "SaveConfigurationParameter"

type

type: object

className

className: string = "SaveConfigurationParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

branch

branch: object

required

required: true = true

serializedName

serializedName: string = "properties.branch"

type

type: object

name

name: "String" = "String"

force

force: object

serializedName

serializedName: string = "properties.force"

type

type: object

name

name: "Boolean" = "Boolean"

Const SchemaCollection

SchemaCollection: object
interface

The response of the list schema operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SchemaCollection"

__@iterator

  • Iterator

    Returns IterableIterator<SchemaContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SchemaContract>[]

      Additional items to add to the end of array1.

    Returns SchemaContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SchemaContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SchemaContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SchemaContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SchemaContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SchemaContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SchemaContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SchemaContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns SchemaContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SchemaContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SchemaContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SchemaContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SchemaContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SchemaContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SchemaContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns SchemaContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns SchemaContract

  • Parameters

    Returns SchemaContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns SchemaContract

  • Parameters

    Returns SchemaContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns SchemaContract[]

shift

  • Removes the first element from an array and returns it.

    Returns SchemaContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SchemaContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SchemaContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SchemaContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SchemaContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns SchemaContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SchemaContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<SchemaContract>

type

type: object

className

className: string = "SchemaCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SchemaContract"

name

name: "Composite" = "Composite"

Const SchemaContract

SchemaContract: object

Schema Contract details.

contentType

contentType: string

Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.

Optional document

document: any

Properties of the Schema Document.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SchemaContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "SchemaContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentType

contentType: object

required

required: true = true

serializedName

serializedName: string = "properties.contentType"

type

type: object

name

name: "String" = "String"

document

document: object

serializedName

serializedName: string = "properties.document"

type

type: object

name

name: "Object" = "Object"

Const SchemaCreateOrUpdateContract

SchemaCreateOrUpdateContract: object

Schema Contract details.

contentType

contentType: string

Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional value

value: undefined | string

Json escaped string defining the document representing the Schema.

serializedName

serializedName: string = "SchemaCreateOrUpdateContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "SchemaCreateOrUpdateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentType

contentType: object

required

required: true = true

serializedName

serializedName: string = "properties.contentType"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "properties.document.value"

type

type: object

name

name: "String" = "String"

Const SignInSettingsGetEntityTagHeaders

SignInSettingsGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "signinsettings-getentitytag-headers"

type

type: object

className

className: string = "SignInSettingsGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const SignInSettingsGetHeaders

SignInSettingsGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "signinsettings-get-headers"

type

type: object

className

className: string = "SignInSettingsGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const SignUpSettingsGetEntityTagHeaders

SignUpSettingsGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "signupsettings-getentitytag-headers"

type

type: object

className

className: string = "SignUpSettingsGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const SignUpSettingsGetHeaders

SignUpSettingsGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "signupsettings-get-headers"

type

type: object

className

className: string = "SignUpSettingsGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const SubscriptionCollection

SubscriptionCollection: object
interface

Paged Subscriptions list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "SubscriptionCollection"

__@iterator

  • Iterator

    Returns IterableIterator<SubscriptionContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns SubscriptionContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SubscriptionContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SubscriptionContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SubscriptionContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SubscriptionContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SubscriptionContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SubscriptionContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns SubscriptionContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SubscriptionContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SubscriptionContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SubscriptionContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns SubscriptionContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns SubscriptionContract

  • Parameters

    Returns SubscriptionContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns SubscriptionContract

  • Parameters

    Returns SubscriptionContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns SubscriptionContract[]

shift

  • Removes the first element from an array and returns it.

    Returns SubscriptionContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SubscriptionContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SubscriptionContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SubscriptionContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns SubscriptionContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<SubscriptionContract>

type

type: object

className

className: string = "SubscriptionCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubscriptionContract"

name

name: "Composite" = "Composite"

Const SubscriptionContract

SubscriptionContract: object

Subscription details.

Optional allowTracing

allowTracing: undefined | false | true

Determines whether tracing is enabled

Optional createdDate

createdDate: Date

Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

The name of the subscription, or null if the subscription has no name.

Optional endDate

endDate: Date

Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional expirationDate

expirationDate: Date

Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notificationDate

notificationDate: Date

Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional ownerId

ownerId: undefined | string

The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.

primaryKey

primaryKey: string

Subscription primary key.

scope

scope: string

Scope like /products/{productId} or /apis or /apis/{apiId}.

secondaryKey

secondaryKey: string

Subscription secondary key.

Optional startDate

startDate: Date

Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

state

state: SubscriptionState

Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'

Optional stateComment

stateComment: undefined | string

Optional subscription comment added by an administrator.

serializedName

serializedName: string = "SubscriptionContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "SubscriptionContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowTracing

allowTracing: object

serializedName

serializedName: string = "properties.allowTracing"

type

type: object

name

name: "Boolean" = "Boolean"

createdDate

createdDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdDate"

type

type: object

name

name: "DateTime" = "DateTime"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 0

type

type: object

name

name: "String" = "String"

endDate

endDate: object

serializedName

serializedName: string = "properties.endDate"

type

type: object

name

name: "DateTime" = "DateTime"

expirationDate

expirationDate: object

serializedName

serializedName: string = "properties.expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

notificationDate

notificationDate: object

serializedName

serializedName: string = "properties.notificationDate"

type

type: object

name

name: "DateTime" = "DateTime"

ownerId

ownerId: object

serializedName

serializedName: string = "properties.ownerId"

type

type: object

name

name: "String" = "String"

primaryKey

primaryKey: object

required

required: true = true

serializedName

serializedName: string = "properties.primaryKey"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

scope

scope: object

required

required: true = true

serializedName

serializedName: string = "properties.scope"

type

type: object

name

name: "String" = "String"

secondaryKey

secondaryKey: object

required

required: true = true

serializedName

serializedName: string = "properties.secondaryKey"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

startDate

startDate: object

serializedName

serializedName: string = "properties.startDate"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

required

required: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["suspended","active","expired","submitted","rejected","cancelled"]

name

name: "Enum" = "Enum"

stateComment

stateComment: object

serializedName

serializedName: string = "properties.stateComment"

type

type: object

name

name: "String" = "String"

Const SubscriptionCreateOrUpdateHeaders

SubscriptionCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "subscription-createorupdate-headers"

type

type: object

className

className: string = "SubscriptionCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const SubscriptionCreateParameters

SubscriptionCreateParameters: object

Subscription create details.

Optional allowTracing

allowTracing: undefined | false | true

Determines whether tracing can be enabled

displayName

displayName: string

Subscription name.

Optional ownerId

ownerId: undefined | string

User (user id path) for whom subscription is being created in form /users/{userId}

Optional primaryKey

primaryKey: undefined | string

Primary subscription key. If not specified during request key will be generated automatically.

scope

scope: string

Scope like /products/{productId} or /apis or /apis/{apiId}.

Optional secondaryKey

secondaryKey: undefined | string

Secondary subscription key. If not specified during request key will be generated automatically.

Optional state

state: SubscriptionState

Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'

serializedName

serializedName: string = "SubscriptionCreateParameters"

type

type: object

className

className: string = "SubscriptionCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowTracing

allowTracing: object

serializedName

serializedName: string = "properties.allowTracing"

type

type: object

name

name: "Boolean" = "Boolean"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

ownerId

ownerId: object

serializedName

serializedName: string = "properties.ownerId"

type

type: object

name

name: "String" = "String"

primaryKey

primaryKey: object

serializedName

serializedName: string = "properties.primaryKey"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

scope

scope: object

required

required: true = true

serializedName

serializedName: string = "properties.scope"

type

type: object

name

name: "String" = "String"

secondaryKey

secondaryKey: object

serializedName

serializedName: string = "properties.secondaryKey"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["suspended","active","expired","submitted","rejected","cancelled"]

name

name: "Enum" = "Enum"

Const SubscriptionGetEntityTagHeaders

SubscriptionGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "subscription-getentitytag-headers"

type

type: object

className

className: string = "SubscriptionGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const SubscriptionGetHeaders

SubscriptionGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "subscription-get-headers"

type

type: object

className

className: string = "SubscriptionGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const SubscriptionKeyParameterNamesContract

SubscriptionKeyParameterNamesContract: object

Subscription key parameter names details.

Optional header

header: undefined | string

Subscription key header name.

Optional query

query: undefined | string

Subscription key query string parameter name.

serializedName

serializedName: string = "SubscriptionKeyParameterNamesContract"

type

type: object

className

className: string = "SubscriptionKeyParameterNamesContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

header

header: object

serializedName

serializedName: string = "header"

type

type: object

name

name: "String" = "String"

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "String" = "String"

Const SubscriptionUpdateParameters

SubscriptionUpdateParameters: object

Subscription update details.

Optional allowTracing

allowTracing: undefined | false | true

Determines whether tracing can be enabled

Optional displayName

displayName: undefined | string

Subscription name.

Optional expirationDate

expirationDate: Date

Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional ownerId

ownerId: undefined | string

User identifier path: /users/{userId}

Optional primaryKey

primaryKey: undefined | string

Primary subscription key.

Optional scope

scope: undefined | string

Scope like /products/{productId} or /apis or /apis/{apiId}

Optional secondaryKey

secondaryKey: undefined | string

Secondary subscription key.

Optional state

state: SubscriptionState

Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'

Optional stateComment

stateComment: undefined | string

Comments describing subscription state change by the administrator.

serializedName

serializedName: string = "SubscriptionUpdateParameters"

type

type: object

className

className: string = "SubscriptionUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowTracing

allowTracing: object

serializedName

serializedName: string = "properties.allowTracing"

type

type: object

name

name: "Boolean" = "Boolean"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

expirationDate

expirationDate: object

serializedName

serializedName: string = "properties.expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

ownerId

ownerId: object

serializedName

serializedName: string = "properties.ownerId"

type

type: object

name

name: "String" = "String"

primaryKey

primaryKey: object

serializedName

serializedName: string = "properties.primaryKey"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

scope

scope: object

serializedName

serializedName: string = "properties.scope"

type

type: object

name

name: "String" = "String"

secondaryKey

secondaryKey: object

serializedName

serializedName: string = "properties.secondaryKey"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["suspended","active","expired","submitted","rejected","cancelled"]

name

name: "Enum" = "Enum"

stateComment

stateComment: object

serializedName

serializedName: string = "properties.stateComment"

type

type: object

name

name: "String" = "String"

Const SubscriptionsDelegationSettingsProperties

SubscriptionsDelegationSettingsProperties: object

Subscriptions delegation settings properties.

Optional enabled

enabled: undefined | false | true

Enable or disable delegation for subscriptions.

serializedName

serializedName: string = "SubscriptionsDelegationSettingsProperties"

type

type: object

className

className: string = "SubscriptionsDelegationSettingsProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const TagAssignToApiHeaders

TagAssignToApiHeaders: object

Defines headers for AssignToApi operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-assigntoapi-headers"

type

type: object

className

className: string = "TagAssignToApiHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagCollection

TagCollection: object
interface

Paged Tag list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "TagCollection"

__@iterator

  • Iterator

    Returns IterableIterator<TagContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<TagContract>[]

      Additional items to add to the end of array1.

    Returns TagContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns TagContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, TagContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: TagContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: TagContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): TagContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns TagContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): TagContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns TagContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: TagContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: TagContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: TagContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: TagContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: TagContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: TagContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns TagContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: TagContract[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns TagContract

  • Parameters

    Returns TagContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): TagContract
  • reduceRight(callbackfn: function, initialValue: TagContract): TagContract
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns TagContract

  • Parameters

    Returns TagContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns TagContract[]

shift

  • Removes the first element from an array and returns it.

    Returns TagContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): TagContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns TagContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns TagContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: TagContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns TagContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: TagContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<TagContract>

type

type: object

className

className: string = "TagCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TagContract"

name

name: "Composite" = "Composite"

Const TagContract

TagContract: object

Tag Contract details.

displayName

displayName: string

Tag name.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TagContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "TagContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 160

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const TagCreateOrUpdateHeaders

TagCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-createorupdate-headers"

type

type: object

className

className: string = "TagCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagCreateUpdateParameters

TagCreateUpdateParameters: object

Parameters supplied to Create/Update Tag operations.

displayName

displayName: string

Tag name.

serializedName

serializedName: string = "TagCreateUpdateParameters"

type

type: object

className

className: string = "TagCreateUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 160

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const TagDescriptionCollection

TagDescriptionCollection: object
interface

Paged TagDescription list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "TagDescriptionCollection"

__@iterator

  • Iterator

    Returns IterableIterator<TagDescriptionContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns TagDescriptionContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns TagDescriptionContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, TagDescriptionContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: TagDescriptionContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): TagDescriptionContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns TagDescriptionContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): TagDescriptionContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns TagDescriptionContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: TagDescriptionContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: TagDescriptionContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: TagDescriptionContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns TagDescriptionContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns TagDescriptionContract[]

shift

  • Removes the first element from an array and returns it.

    Returns TagDescriptionContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns TagDescriptionContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns TagDescriptionContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: TagDescriptionContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns TagDescriptionContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<TagDescriptionContract>

type

type: object

className

className: string = "TagDescriptionCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TagDescriptionContract"

name

name: "Composite" = "Composite"

Const TagDescriptionContract

TagDescriptionContract: object

Contract details.

Optional description

description: undefined | string

Description of the Tag.

Optional displayName

displayName: undefined | string

Tag name.

Optional externalDocsDescription

externalDocsDescription: undefined | string

Description of the external resources describing the tag.

Optional externalDocsUrl

externalDocsUrl: undefined | string

Absolute URL of external resources describing the tag.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TagDescriptionContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "TagDescriptionContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

constraints

constraints: object

MaxLength

MaxLength: number = 160

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

externalDocsDescription

externalDocsDescription: object

serializedName

serializedName: string = "properties.externalDocsDescription"

type

type: object

name

name: "String" = "String"

externalDocsUrl

externalDocsUrl: object

serializedName

serializedName: string = "properties.externalDocsUrl"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

type

type: object

name

name: "String" = "String"

Const TagDescriptionCreateParameters

TagDescriptionCreateParameters: object

Parameters supplied to the Create TagDescription operation.

Optional description

description: undefined | string

Description of the Tag.

Optional externalDocsDescription

externalDocsDescription: undefined | string

Description of the external resources describing the tag.

Optional externalDocsUrl

externalDocsUrl: undefined | string

Absolute URL of external resources describing the tag.

serializedName

serializedName: string = "TagDescriptionCreateParameters"

type

type: object

className

className: string = "TagDescriptionCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

externalDocsDescription

externalDocsDescription: object

serializedName

serializedName: string = "properties.externalDocsDescription"

type

type: object

name

name: "String" = "String"

externalDocsUrl

externalDocsUrl: object

serializedName

serializedName: string = "properties.externalDocsUrl"

constraints

constraints: object

MaxLength

MaxLength: number = 2000

type

type: object

name

name: "String" = "String"

Const TagGetByApiHeaders

TagGetByApiHeaders: object

Defines headers for GetByApi operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-getbyapi-headers"

type

type: object

className

className: string = "TagGetByApiHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagGetByOperationHeaders

TagGetByOperationHeaders: object

Defines headers for GetByOperation operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-getbyoperation-headers"

type

type: object

className

className: string = "TagGetByOperationHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagGetByProductHeaders

TagGetByProductHeaders: object

Defines headers for GetByProduct operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-getbyproduct-headers"

type

type: object

className

className: string = "TagGetByProductHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagGetEntityStateByApiHeaders

TagGetEntityStateByApiHeaders: object

Defines headers for GetEntityStateByApi operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-getentitystatebyapi-headers"

type

type: object

className

className: string = "TagGetEntityStateByApiHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagGetEntityStateByOperationHeaders

TagGetEntityStateByOperationHeaders: object

Defines headers for GetEntityStateByOperation operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-getentitystatebyoperation-headers"

type

type: object

className

className: string = "TagGetEntityStateByOperationHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagGetEntityStateByProductHeaders

TagGetEntityStateByProductHeaders: object

Defines headers for GetEntityStateByProduct operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-getentitystatebyproduct-headers"

type

type: object

className

className: string = "TagGetEntityStateByProductHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagGetEntityStateHeaders

TagGetEntityStateHeaders: object

Defines headers for GetEntityState operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-getentitystate-headers"

type

type: object

className

className: string = "TagGetEntityStateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagGetHeaders

TagGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tag-get-headers"

type

type: object

className

className: string = "TagGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TagResourceCollection

TagResourceCollection: object
interface

Paged Tag list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "TagResourceCollection"

__@iterator

  • Iterator

    Returns IterableIterator<TagResourceContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<TagResourceContract>[]

      Additional items to add to the end of array1.

    Returns TagResourceContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns TagResourceContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, TagResourceContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: TagResourceContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): TagResourceContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns TagResourceContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): TagResourceContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns TagResourceContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: TagResourceContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: TagResourceContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: TagResourceContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns TagResourceContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns TagResourceContract

  • Parameters

    Returns TagResourceContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns TagResourceContract

  • Parameters

    Returns TagResourceContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns TagResourceContract[]

shift

  • Removes the first element from an array and returns it.

    Returns TagResourceContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns TagResourceContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns TagResourceContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: TagResourceContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns TagResourceContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<TagResourceContract>

type

type: object

className

className: string = "TagResourceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TagResourceContract"

name

name: "Composite" = "Composite"

Const TagResourceContract

TagResourceContract: object

TagResource contract properties.

Optional api

api: ApiTagResourceContractProperties

Api associated with the tag.

Optional operation

operation: OperationTagResourceContractProperties

Operation associated with the tag.

Optional product

product: ProductTagResourceContractProperties

Product associated with the tag.

tag

tag: TagTagResourceContractProperties

Tag associated with the resource.

serializedName

serializedName: string = "TagResourceContract"

type

type: object

className

className: string = "TagResourceContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

api

api: object

serializedName

serializedName: string = "api"

type

type: object

className

className: string = "ApiTagResourceContractProperties"

name

name: "Composite" = "Composite"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

className

className: string = "OperationTagResourceContractProperties"

name

name: "Composite" = "Composite"

product

product: object

serializedName

serializedName: string = "product"

type

type: object

className

className: string = "ProductTagResourceContractProperties"

name

name: "Composite" = "Composite"

tag

tag: object

required

required: true = true

serializedName

serializedName: string = "tag"

type

type: object

className

className: string = "TagTagResourceContractProperties"

name

name: "Composite" = "Composite"

Const TagTagResourceContractProperties

TagTagResourceContractProperties: object

Contract defining the Tag property in the Tag Resource Contract

Optional id

id: undefined | string

Tag identifier

Optional name

name: undefined | string

Tag Name

serializedName

serializedName: string = "TagTagResourceContractProperties"

type

type: object

className

className: string = "TagTagResourceContractProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

constraints

constraints: object

MaxLength

MaxLength: number = 160

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const TenantAccessGetEntityTagHeaders

TenantAccessGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tenantaccess-getentitytag-headers"

type

type: object

className

className: string = "TenantAccessGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TenantAccessGetHeaders

TenantAccessGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tenantaccess-get-headers"

type

type: object

className

className: string = "TenantAccessGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TenantAccessGitGetHeaders

TenantAccessGitGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "tenantaccessgit-get-headers"

type

type: object

className

className: string = "TenantAccessGitGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const TenantConfigurationSyncStateContract

TenantConfigurationSyncStateContract: object

Tenant Configuration Synchronization State.

Optional branch

branch: undefined | string

The name of Git branch.

Optional commitId

commitId: undefined | string

The latest commit Id.

Optional configurationChangeDate

configurationChangeDate: Date

The date of the latest configuration change. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional isExport

isExport: undefined | false | true

value indicating if last sync was save (true) or deploy (false) operation.

Optional isGitEnabled

isGitEnabled: undefined | false | true

value indicating whether Git configuration access is enabled.

Optional isSynced

isSynced: undefined | false | true

value indicating if last synchronization was later than the configuration change.

Optional syncDate

syncDate: Date

The date of the latest synchronization. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

serializedName

serializedName: string = "TenantConfigurationSyncStateContract"

type

type: object

className

className: string = "TenantConfigurationSyncStateContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

branch

branch: object

serializedName

serializedName: string = "branch"

type

type: object

name

name: "String" = "String"

commitId

commitId: object

serializedName

serializedName: string = "commitId"

type

type: object

name

name: "String" = "String"

configurationChangeDate

configurationChangeDate: object

serializedName

serializedName: string = "configurationChangeDate"

type

type: object

name

name: "DateTime" = "DateTime"

isExport

isExport: object

serializedName

serializedName: string = "isExport"

type

type: object

name

name: "Boolean" = "Boolean"

isGitEnabled

isGitEnabled: object

serializedName

serializedName: string = "isGitEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

isSynced

isSynced: object

serializedName

serializedName: string = "isSynced"

type

type: object

name

name: "Boolean" = "Boolean"

syncDate

syncDate: object

serializedName

serializedName: string = "syncDate"

type

type: object

name

name: "DateTime" = "DateTime"

Const TermsOfServiceProperties

TermsOfServiceProperties: object

Terms of service contract properties.

Optional consentRequired

consentRequired: undefined | false | true

Ask user for consent to the terms of service.

Optional enabled

enabled: undefined | false | true

Display terms of service during a sign-up process.

Optional text

text: undefined | string

A terms of service text.

serializedName

serializedName: string = "TermsOfServiceProperties"

type

type: object

className

className: string = "TermsOfServiceProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

consentRequired

consentRequired: object

serializedName

serializedName: string = "consentRequired"

type

type: object

name

name: "Boolean" = "Boolean"

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

text

text: object

serializedName

serializedName: string = "text"

type

type: object

name

name: "String" = "String"

Const TokenBodyParameterContract

TokenBodyParameterContract: object

OAuth acquire token request body parameter (www-url-form-encoded).

name

name: string

body parameter name.

value

value: string

body parameter value.

serializedName

serializedName: string = "TokenBodyParameterContract"

type

type: object

className

className: string = "TokenBodyParameterContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const UserCollection

UserCollection: object
interface

Paged Users list representation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "UserCollection"

__@iterator

  • Iterator

    Returns IterableIterator<UserContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<UserContract>[]

      Additional items to add to the end of array1.

    Returns UserContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns UserContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, UserContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: UserContract, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: UserContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): UserContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns UserContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): UserContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns UserContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: UserContract, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: UserContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: UserContract, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: UserContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: UserContract, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: UserContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns UserContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns UserContract

  • Parameters

    Returns UserContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): UserContract
  • reduceRight(callbackfn: function, initialValue: UserContract): UserContract
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns UserContract

  • Parameters

    Returns UserContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns UserContract[]

shift

  • Removes the first element from an array and returns it.

    Returns UserContract | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): UserContract[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns UserContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns UserContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: UserContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns UserContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: UserContract[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<UserContract>

type

type: object

className

className: string = "UserCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserContract"

name

name: "Composite" = "Composite"

Const UserContract

UserContract: object

User details.

Optional email

email: undefined | string

Email address.

Optional firstName

firstName: undefined | string

First name.

Optional groups

groups: GroupContractProperties[]

Collection of groups user is part of. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identities

identities: UserIdentityContract[]

Collection of user identities.

Optional lastName

lastName: undefined | string

Last name.

Optional name

name: undefined | string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional note

note: undefined | string

Optional note about a user set by the administrator.

Optional registrationDate

registrationDate: Date

Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Optional state

state: UserState

Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'active', 'blocked', 'pending', 'deleted'. Default value: 'active'.

serializedName

serializedName: string = "UserContract"

Optional type

type: object

Resource type for API Management resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "UserContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

email

email: object

serializedName

serializedName: string = "properties.email"

type

type: object

name

name: "String" = "String"

firstName

firstName: object

serializedName

serializedName: string = "properties.firstName"

type

type: object

name

name: "String" = "String"

groups

groups: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.groups"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GroupContractProperties"

name

name: "Composite" = "Composite"

identities

identities: object

serializedName

serializedName: string = "properties.identities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserIdentityContract"

name

name: "Composite" = "Composite"

lastName

lastName: object

serializedName

serializedName: string = "properties.lastName"

type

type: object

name

name: "String" = "String"

note

note: object

serializedName

serializedName: string = "properties.note"

type

type: object

name

name: "String" = "String"

registrationDate

registrationDate: object

serializedName

serializedName: string = "properties.registrationDate"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

defaultValue

defaultValue: string = "active"

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const UserCreateOrUpdateHeaders

UserCreateOrUpdateHeaders: object

Defines headers for CreateOrUpdate operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "user-createorupdate-headers"

type

type: object

className

className: string = "UserCreateOrUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const UserCreateParameters

UserCreateParameters: object

User create details.

Optional confirmation

confirmation: Confirmation

Determines the type of confirmation e-mail that will be sent to the newly created user. Possible values include: 'signup', 'invite'

email

email: string

Email address. Must not be empty and must be unique within the service instance.

firstName

firstName: string

First name.

Optional identities

identities: UserIdentityContract[]

Collection of user identities.

lastName

lastName: string

Last name.

Optional note

note: undefined | string

Optional note about a user set by the administrator.

Optional password

password: undefined | string

User Password. If no value is provided, a default password is generated.

Optional state

state: UserState

Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'active', 'blocked', 'pending', 'deleted'. Default value: 'active'.

serializedName

serializedName: string = "UserCreateParameters"

type

type: object

className

className: string = "UserCreateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

confirmation

confirmation: object

serializedName

serializedName: string = "properties.confirmation"

type

type: object

name

name: "String" = "String"

email

email: object

required

required: true = true

serializedName

serializedName: string = "properties.email"

constraints

constraints: object

MaxLength

MaxLength: number = 254

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

firstName

firstName: object

required

required: true = true

serializedName

serializedName: string = "properties.firstName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

identities

identities: object

serializedName

serializedName: string = "properties.identities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserIdentityContract"

name

name: "Composite" = "Composite"

lastName

lastName: object

required

required: true = true

serializedName

serializedName: string = "properties.lastName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

note

note: object

serializedName

serializedName: string = "properties.note"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

state

state: object

defaultValue

defaultValue: string = "active"

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const UserEntityBaseParameters

UserEntityBaseParameters: object

User Entity Base Parameters set.

Optional identities

identities: UserIdentityContract[]

Collection of user identities.

Optional note

note: undefined | string

Optional note about a user set by the administrator.

Optional state

state: UserState

Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'active', 'blocked', 'pending', 'deleted'. Default value: 'active'.

serializedName

serializedName: string = "UserEntityBaseParameters"

type

type: object

className

className: string = "UserEntityBaseParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

identities

identities: object

serializedName

serializedName: string = "identities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserIdentityContract"

name

name: "Composite" = "Composite"

note

note: object

serializedName

serializedName: string = "note"

type

type: object

name

name: "String" = "String"

state

state: object

defaultValue

defaultValue: string = "active"

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const UserGetEntityTagHeaders

UserGetEntityTagHeaders: object

Defines headers for GetEntityTag operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "user-getentitytag-headers"

type

type: object

className

className: string = "UserGetEntityTagHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const UserGetHeaders

UserGetHeaders: object

Defines headers for Get operation.

eTag

eTag: string

Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

serializedName

serializedName: string = "user-get-headers"

type

type: object

className

className: string = "UserGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

Const UserIdentityCollection

UserIdentityCollection: object
interface

List of Users Identity list representation.

extends

Array

Array

Array: ArrayConstructor

Optional count

count: undefined | number

Total record count number across all pages.

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Next page link if any.

serializedName

serializedName: string = "UserIdentityCollection"

__@iterator

  • Iterator

    Returns IterableIterator<UserIdentityContract>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns UserIdentityContract[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns UserIdentityContract[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, UserIdentityContract]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: UserIdentityContract

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): UserIdentityContract[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns UserIdentityContract[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): UserIdentityContract | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns UserIdentityContract | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: UserIdentityContract

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: UserIdentityContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: UserIdentityContract

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns UserIdentityContract | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns UserIdentityContract

  • Parameters

    Returns UserIdentityContract

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns UserIdentityContract

  • Parameters

    Returns UserIdentityContract

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns UserIdentityContract[]

shift

  • Removes the first element from an array and returns it.

    Returns UserIdentityContract | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns UserIdentityContract[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns UserIdentityContract[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: UserIdentityContract[]

      Elements to insert into the array in place of the deleted elements.

    Returns UserIdentityContract[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<UserIdentityContract>

type

type: object

className

className: string = "UserIdentityCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserIdentityContract"

name

name: "Composite" = "Composite"

Const UserIdentityContract

UserIdentityContract: object

User identity details.

Optional id

id: undefined | string

Identifier value within provider.

Optional provider

provider: undefined | string

Identity provider name.

serializedName

serializedName: string = "UserIdentityContract"

type

type: object

className

className: string = "UserIdentityContract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

Const UserTokenParameters

UserTokenParameters: object

Get User Token parameters.

expiry

expiry: Date

The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

keyType

keyType: KeyType

The Key to be used to generate token for user. Possible values include: 'primary', 'secondary'. Default value: 'primary'.

serializedName

serializedName: string = "UserTokenParameters"

type

type: object

className

className: string = "UserTokenParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiry

expiry: object

required

required: true = true

serializedName

serializedName: string = "properties.expiry"

type

type: object

name

name: "DateTime" = "DateTime"

keyType

keyType: object

defaultValue

defaultValue: string = "primary"

required

required: true = true

serializedName

serializedName: string = "properties.keyType"

type

type: object

allowedValues

allowedValues: string[] = ["primary","secondary"]

name

name: "Enum" = "Enum"

Const UserTokenResult

UserTokenResult: object

Get User Token response details.

Optional value

value: undefined | string

Shared Access Authorization token for the User.

serializedName

serializedName: string = "UserTokenResult"

type

type: object

className

className: string = "UserTokenResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const UserUpdateParameters

UserUpdateParameters: object

User update parameters.

Optional email

email: undefined | string

Email address. Must not be empty and must be unique within the service instance.

Optional firstName

firstName: undefined | string

First name.

Optional identities

identities: UserIdentityContract[]

Collection of user identities.

Optional lastName

lastName: undefined | string

Last name.

Optional note

note: undefined | string

Optional note about a user set by the administrator.

Optional password

password: undefined | string

User Password.

Optional state

state: UserState

Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'active', 'blocked', 'pending', 'deleted'. Default value: 'active'.

serializedName

serializedName: string = "UserUpdateParameters"

type

type: object

className

className: string = "UserUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

email

email: object

serializedName

serializedName: string = "properties.email"

constraints

constraints: object

MaxLength

MaxLength: number = 254

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

firstName

firstName: object

serializedName

serializedName: string = "properties.firstName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

identities

identities: object

serializedName

serializedName: string = "properties.identities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserIdentityContract"

name

name: "Composite" = "Composite"

lastName

lastName: object

serializedName

serializedName: string = "properties.lastName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

note

note: object

serializedName

serializedName: string = "properties.note"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

state

state: object

defaultValue

defaultValue: string = "active"

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkConfiguration

VirtualNetworkConfiguration: object

Configuration of a virtual network to which API Management service is deployed.

Optional subnetResourceId

subnetResourceId: undefined | string

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

Optional subnetname

subnetname: undefined | string

The name of the subnet. NOTE: This property will not be serialized. It can only be populated by the server.

Optional vnetid

vnetid: undefined | string

The virtual network ID. This is typically a GUID. Expect a null GUID by default. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkConfiguration"

type

type: object

className

className: string = "VirtualNetworkConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

subnetResourceId

subnetResourceId: object

serializedName

serializedName: string = "subnetResourceId"

constraints

constraints: object

Pattern

Pattern: RegExp = /^\/subscriptions\/[^\/]*\/resourceGroups\/[^\/]*\/providers\/Microsoft.(ClassicNetwork|Network)\/virtualNetworks\/[^\/]*\/subnets\/[^\/]*$/

type

type: object

name

name: "String" = "String"

subnetname

subnetname: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "subnetname"

type

type: object

name

name: "String" = "String"

vnetid

vnetid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "vnetid"

type

type: object

name

name: "String" = "String"

Const X509CertificateName

X509CertificateName: object

Properties of server X509Names.

Optional issuerCertificateThumbprint

issuerCertificateThumbprint: undefined | string

Thumbprint for the Issuer of the Certificate.

Optional name

name: undefined | string

Common Name of the Certificate.

serializedName

serializedName: string = "X509CertificateName"

type

type: object

className

className: string = "X509CertificateName"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

issuerCertificateThumbprint

issuerCertificateThumbprint: object

serializedName

serializedName: string = "issuerCertificateThumbprint"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const accessName

accessName: object

parameterPath

parameterPath: string = "accessName"

mapper

mapper: object

defaultValue

defaultValue: string = "access"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "accessName"

type

type: object

name

name: "String" = "String"

Const apiId0

apiId0: object

parameterPath

parameterPath: string = "apiId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "apiId"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const apiId1

apiId1: object

parameterPath

parameterPath: string = "apiId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "apiId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const attachmentId

attachmentId: object

parameterPath

parameterPath: string = "attachmentId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "attachmentId"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const authsid

authsid: object

parameterPath

parameterPath: string = "authsid"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "authsid"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const backendId

backendId: object

parameterPath

parameterPath: string = "backendId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backendId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const cacheId

cacheId: object

parameterPath

parameterPath: string = "cacheId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "cacheId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const certificateId

certificateId: object

parameterPath

parameterPath: string = "certificateId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "certificateId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const commentId

commentId: object

parameterPath

parameterPath: string = "commentId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "commentId"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const configurationName

configurationName: object

parameterPath

parameterPath: string = "configurationName"

mapper

mapper: object

defaultValue

defaultValue: string = "configuration"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "configurationName"

type

type: object

name

name: "String" = "String"

Const deleteRevisions

deleteRevisions: object

parameterPath

parameterPath: string[] = ["options","deleteRevisions"]

mapper

mapper: object

serializedName

serializedName: string = "deleteRevisions"

type

type: object

name

name: "Boolean" = "Boolean"

Const deleteSubscriptions

deleteSubscriptions: object

parameterPath

parameterPath: string[] = ["options","deleteSubscriptions"]

mapper

mapper: object

serializedName

serializedName: string = "deleteSubscriptions"

type

type: object

name

name: "Boolean" = "Boolean"

Const diagnosticId

diagnosticId: object

parameterPath

parameterPath: string = "diagnosticId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "diagnosticId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const email

email: object

parameterPath

parameterPath: string = "email"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "email"

type

type: object

name

name: "String" = "String"

Const expandApiVersionSet

expandApiVersionSet: object

parameterPath

parameterPath: string[] = ["options","expandApiVersionSet"]

mapper

mapper: object

serializedName

serializedName: string = "expandApiVersionSet"

type

type: object

name

name: "Boolean" = "Boolean"

Const expandCommentsAttachments

expandCommentsAttachments: object

parameterPath

parameterPath: string[] = ["options","expandCommentsAttachments"]

mapper

mapper: object

serializedName

serializedName: string = "expandCommentsAttachments"

type

type: object

name

name: "Boolean" = "Boolean"

Const expandGroups

expandGroups: object

parameterPath

parameterPath: string[] = ["options","expandGroups"]

mapper

mapper: object

serializedName

serializedName: string = "expandGroups"

type

type: object

name

name: "Boolean" = "Boolean"

Const exportParameter

exportParameter: object

parameterPath

parameterPath: string = "exportParameter"

mapper

mapper: object

defaultValue

defaultValue: string = "true"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "export"

type

type: object

name

name: "String" = "String"

Const filter0

filter0: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter1

filter1: object

parameterPath

parameterPath: string = "filter"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const force

force: object

parameterPath

parameterPath: string[] = ["options","force"]

mapper

mapper: object

serializedName

serializedName: string = "force"

type

type: object

name

name: "Boolean" = "Boolean"

Const format0

format0: object

parameterPath

parameterPath: string[] = ["options","format"]

mapper

mapper: object

defaultValue

defaultValue: string = "xml"

serializedName

serializedName: string = "format"

type

type: object

name

name: "String" = "String"

Const format1

format1: object

parameterPath

parameterPath: string = "format"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "format"

type

type: object

name

name: "String" = "String"

Const groupId

groupId: object

parameterPath

parameterPath: string = "groupId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "groupId"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const identityProviderName

identityProviderName: object

parameterPath

parameterPath: string = "identityProviderName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "identityProviderName"

type

type: object

name

name: "String" = "String"

Const ifMatch0

ifMatch0: object

parameterPath

parameterPath: string[] = ["options","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch1

ifMatch1: object

parameterPath

parameterPath: string = "ifMatch"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const includeNotTaggedApis

includeNotTaggedApis: object

parameterPath

parameterPath: string[] = ["options","includeNotTaggedApis"]

mapper

mapper: object

serializedName

serializedName: string = "includeNotTaggedApis"

type

type: object

name

name: "Boolean" = "Boolean"

Const includeNotTaggedOperations

includeNotTaggedOperations: object

parameterPath

parameterPath: string[] = ["options","includeNotTaggedOperations"]

mapper

mapper: object

serializedName

serializedName: string = "includeNotTaggedOperations"

type

type: object

name

name: "Boolean" = "Boolean"

Const includeNotTaggedProducts

includeNotTaggedProducts: object

parameterPath

parameterPath: string[] = ["options","includeNotTaggedProducts"]

mapper

mapper: object

serializedName

serializedName: string = "includeNotTaggedProducts"

type

type: object

name

name: "Boolean" = "Boolean"

Const interval

interval: object

parameterPath

parameterPath: string = "interval"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "interval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const issueId

issueId: object

parameterPath

parameterPath: string = "issueId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "issueId"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const locationName

locationName: object

parameterPath

parameterPath: string = "locationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "locationName"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const loggerId

loggerId: object

parameterPath

parameterPath: string = "loggerId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "loggerId"

constraints

constraints: object

MaxLength

MaxLength: number = 256

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const notificationName

notificationName: object

parameterPath

parameterPath: string = "notificationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "notificationName"

type

type: object

name

name: "String" = "String"

Const notify

notify: object

parameterPath

parameterPath: string[] = ["options","notify"]

mapper

mapper: object

serializedName

serializedName: string = "notify"

type

type: object

name

name: "Boolean" = "Boolean"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "operationId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const opid

opid: object

parameterPath

parameterPath: string = "opid"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "opid"

constraints

constraints: object

MaxLength

MaxLength: number = 256

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const orderby

orderby: object

parameterPath

parameterPath: string[] = ["options","orderby"]

mapper

mapper: object

serializedName

serializedName: string = "$orderby"

type

type: object

name

name: "String" = "String"

Const policyId

policyId: object

parameterPath

parameterPath: string = "policyId"

mapper

mapper: object

defaultValue

defaultValue: string = "policy"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

Const productId

productId: object

parameterPath

parameterPath: string = "productId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "productId"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const propId

propId: object

parameterPath

parameterPath: string = "propId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "propId"

constraints

constraints: object

MaxLength

MaxLength: number = 256

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const quotaCounterKey

quotaCounterKey: object

parameterPath

parameterPath: string = "quotaCounterKey"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "quotaCounterKey"

type

type: object

name

name: "String" = "String"

Const quotaPeriodKey

quotaPeriodKey: object

parameterPath

parameterPath: string = "quotaPeriodKey"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "quotaPeriodKey"

type

type: object

name

name: "String" = "String"

Const releaseId

releaseId: object

parameterPath

parameterPath: string = "releaseId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "releaseId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const schemaId

schemaId: object

parameterPath

parameterPath: string = "schemaId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "schemaId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const scope0

scope0: object

parameterPath

parameterPath: string[] = ["options","scope"]

mapper

mapper: object

serializedName

serializedName: string = "scope"

type

type: object

name

name: "String" = "String"

Const scope1

scope1: object

parameterPath

parameterPath: string[] = ["options","scope"]

mapper

mapper: object

serializedName

serializedName: string = "scope"

type

type: object

allowedValues

allowedValues: string[] = ["Tenant","Product","Api","Operation","All"]

name

name: "Enum" = "Enum"

Const serviceName

serviceName: object

parameterPath

parameterPath: string = "serviceName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "serviceName"

constraints

constraints: object

MaxLength

MaxLength: number = 50

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$/

type

type: object

name

name: "String" = "String"

Const sid

sid: object

parameterPath

parameterPath: string = "sid"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "sid"

constraints

constraints: object

MaxLength

MaxLength: number = 256

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const skip

skip: object

parameterPath

parameterPath: string[] = ["options","skip"]

mapper

mapper: object

serializedName

serializedName: string = "$skip"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const tagId

tagId: object

parameterPath

parameterPath: string = "tagId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "tagId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const tags

tags: object

parameterPath

parameterPath: string[] = ["options","tags"]

mapper

mapper: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "String" = "String"

Const templateName

templateName: object

parameterPath

parameterPath: string = "templateName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "templateName"

type

type: object

name

name: "String" = "String"

Const top

top: object

parameterPath

parameterPath: string[] = ["options","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const userId

userId: object

parameterPath

parameterPath: string = "userId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "userId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Const versionSetId

versionSetId: object

parameterPath

parameterPath: string = "versionSetId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "versionSetId"

constraints

constraints: object

MaxLength

MaxLength: number = 80

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[^*#&+:<>?]+$/

type

type: object

name

name: "String" = "String"

Generated using TypeDoc